Die Esda Scaffolding Extension für Ruby on Rails

Transkript

1 Die Esda Scaffolding Extension für Ruby on Rails Daniel Schreiber 22. März März 2015 Daniel Schreiber 1 / 25

2 Einführung Demo 22. März 2015 Daniel Schreiber 2 / 25

3 Einführung Hintergrund Entstanden aus Esda Warenwirtschaft (ab 2006) Ziel: Standardoberfläche für Stammdatentabellen Wenig Code pro Tabelle Standardverhalten sinnvoll, aber anpassbar Performant für große Datenmengen GPLv3 Rails 3.2/ März 2015 Daniel Schreiber 3 / 25

4 Ruby on Rails - Kurz und knapp Ruby on Rails - Kurz und knapp MVC-Framework für Webanwungen Models: Tabelle = Klasse, Record = Instanz Controller: Logik hinter den URIs View: rert Template für Client Router: mappt URIs auf Controllermethoden Designprinipien: DRY - Don t repeat yourself Convention over configuration opinionated software Ausgefeilte Introspection-Möglichkeiten Voreinstellungen für Dateisystemlayout, Klasse- und Methodennnamen 22. März 2015 Daniel Schreiber 4 / 25

5 Ruby on Rails - Kurz und knapp ActiveRecord - Rails ORM Philosophie: die Datenbank ist dumm SQLite, PostgreSQL, MySˆWMariaDB Felder aus DB auslesen Beziehungen im Model angeben Datenvalidierung im Model, nicht in DB Trigger before */after * save, update, create validate destroy after commit, after rollback unterstützt Transaktionen auch verschachtelt 22. März 2015 Daniel Schreiber 5 / 25

6 Ruby on Rails - Kurz und knapp ActionPack ActionController Anwungslogik HTTP Parameter verarbeiten Daten aus Datenbank lesen/schreiben Daten für Template zusammensammeln Template angeben i18n, content negotiation, CSRF Schutz ActionView Templates rern verschiedene Templatesysteme: ERB, Builder, weitere aus gems Partials XSS Schutz per default Helper Hilfen für Formulare, Links, Bilder etc 22. März 2015 Daniel Schreiber 6 / 25

7 Ruby on Rails - Kurz und knapp Beispielanwung git clone https :// gitorious. org / scaffold_ example_ app / scaffold_ example_ app. git cd scaffold_ example_ app bundle install rake db: migrate rails server 22. März 2015 Daniel Schreiber 7 / 25

8 Eine eigene Anwung rails new webshop - m " https :// raw. githubusercontent. com / schrd / scaffolding_esda / master / app_template / scaffolding_app_template.rb" cd webshop bundle install rake db: migrate rake db: seed # Models erstellen # Controller generieren 22. März 2015 Daniel Schreiber 8 / 25

9 Datenstrukturen Datenstrukturen Countries name eu 1 n Addresses name street zipcode city country id (FK) 1 Orders order number order date customer id (FK) 1 n 1 n Customers name customer number address id (FK) n Order Items order id (FK) product id (FK) quantity price n 1 Products name description photo product group (FK) n 1 Product Groups name 22. März 2015 Daniel Schreiber 9 / 25

10 Datenstrukturen Datenmodell in Rails rails g model country name : string eu: boolean rails g model address name : text street : string city : string " zipcode : string {10} " country : references : index rails g model customer name : string customer_ number : integer address : references : index rails g model product_ group " name : string { 30} " rails g model product name : string description : text photo : binary product_ group : references : index 22. März 2015 Daniel Schreiber 10 / 25

11 Datenstrukturen Datenmodell in Rails rails g model order order_ number : integer order_ date : date customer : references : index rails g model order_ item order : references : index product : references : index quantity : integer price : decimal Migrations anpassen: NOT NULL angeben 22. März 2015 Daniel Schreiber 11 / 25

12 Controller Controller generieren f o r controller in country address customer product product_ group order order_ item ; do rails g esda : scaffold_ controller $controller done rake db: migrate rake db: seed rails s & sleep 2 firefox http :// localhost : März 2015 Daniel Schreiber 12 / 25

13 Anpassungen im Model Reihenfolge der Felder in Formularen Standard: alle Datenbankfelder alphabetisch, Fremdschlüssel dereferenzieren Anpassung fields Variable oder scaffold fields Klassenmethode c l a s s Address < ActiveRecord :: Base belongs_ to : country has_ many : scaffold_ fields = % w( name street city zipcode country ) 22. März 2015 Daniel Schreiber 13 / 25

14 Anpassungen im Model Felder in Auflistung ändern Standard: wie in Formularen Anpassung browse fields Variable c l a s s Address < ActiveRecord :: Base belongs_ to : country has_ many : scaffold_ fields = % w( name street city zipcode country = %w( name street city zipcode country. name ) 22. März 2015 Daniel Schreiber 14 / 25

15 Anpassungen im Model Darstellung von Fremdschlüsselwerten Standard: Wert des Feldes name, wenn nicht vorhanden, dann to s Überschreiben durch implementieren der scaffold name Methode c l a s s Address < ActiveRecord :: Base belongs_ to : country has_ many : scaffold_ fields = % w( name street city zipcode country = %w( name street city zipcode country. name ) d e f scaffold_ name "#{ self. name } aus #{ self. city }" 22. März 2015 Daniel Schreiber 15 / 25

16 Anpassungen im Model Änderbarkeit von Feldern Standard: alle Felder änderbar Überschreiben durch implementieren der feldname immutable? Methode c l a s s Order < ActiveRecord :: Base belongs_ to : customer has_ many : order_ items def order_number_immutable? not s e l f. new_record? 22. März 2015 Daniel Schreiber 16 / 25

17 Anpassungen im Model Extra Spalten in Auflistung Jede Modelfunktion kann als Spalte verwet werden Hinzufügen zu scaffold browse fields c l a s s Order < ActiveRecord :: Base belongs_ to : customer has_ many : order_ = s e l f. scaffold_fields + [" value "] def value s e l f. order_items. sum (" quantity * price ") 22. März 2015 Daniel Schreiber 17 / 25

18 Anpassungen im Model Suche in Auflistung Berechnete Spalten können durchsucht werden Klassenmethode build conditions for spaltenname implementieren Widget für Suchemaske erstellen c l a s s Order < ActiveRecord :: Base def s e l f. build_conditions_for_value ( table, params_part, param_name ) p_ge = params_part [ param_name ]. try (:[], : from ) p_le = params_part [ param_name ]. try (:[], :to) conditions, condition_params = [], [] u n l e s s p_ge. blank? conditions << " sum ( quantity * price ) >=?" condition_params << BigDecimal. new ( p_ge ) u n l e s s p_le. blank? conditions << " sum ( quantity * price ) <=?" condition_params << BigDecimal. new ( p_le ) return [], [] i f conditions. size == 0 subselect = "#{ table }. id IN ( SELECT order_id from order_items group by order_id HAVING #{ conditions. join ( AND )})" r e t u r n [ subselect ], condition_params 22. März 2015 Daniel Schreiber 18 / 25

19 Anpassungen im Model Widget für Suchmaske module OrderHelper def input_search_for_order_value ( record_name, param_ column_ name, prefix, value, options ) to_number_search_field_tag ( record_name, param_ column_ name, prefix, value, options ) 22. März 2015 Daniel Schreiber 19 / 25

20 Anpassungen im Model Inline Association eine has many Assocation kann inline dargestllt werden c l a s s Order < ActiveRecord :: Base def s e l f. inline_association s e l f. reflect_on_association (: order_items ) 22. März 2015 Daniel Schreiber 20 / 25

21 Anpassungen im Controller Controller Parameter für scaffold Aufruf überschreiben einzelner Methoden before/after/around-filter Für Scaffolding pass befüllen 22. März 2015 Daniel Schreiber 21 / 25

22 Eigene View Templates Nutzbare Helpermethoden Eigenes View Template im Standardpfad ablegen, z.b. app/views/order/edit.html.erb record record scaffold field feldname) scaffold feldname) editable scaffold feldname) scaffold feldname) 22. März 2015 Daniel Schreiber 22 / 25

23 Eigene View Templates Eigenes Widget für Feld Helper implementieren module ProductHelper def product_photo_field ( record, field, name_prefix ) file_field_tag ( html_name ( record. c l a s s, field, name_prefix )) + u n l e s s record. new_record? image_tag ( download_url_for ( record, : photo )) e l s e "" 22. März 2015 Daniel Schreiber 23 / 25

24 Verschiedenes TODO Dokumentation verbessern Auf Rails 4.2 Kompatibilität prüfen Responsive Design Design anpassbarer i18n verbessern Code aus Rails 2.x/3.x Zeiten aufräumen 22. März 2015 Daniel Schreiber 24 / 25

25 Verschiedenes Fragen, Anmerkungen, Wünsche, Bugs bitte an März 2015 Daniel Schreiber 25 / 25