udongo 1.0.3 → 1.0.4

data/readme.md

@@ -1,4 +1,4 @@
-[![Code Climate](https://codeclimate.com/repos/55225453e30ba0015300479e/badges/6cdc017255ce2cab1336/gpa.svg)](https://codeclimate.com/repos/55225453e30ba0015300479e/feed)
+[![Code Climate](https://codeclimate.com/github/udongo/udongo/badges/gpa.svg)](https://codeclimate.com/github/udongo/udongo)
 
 # Concerns
 ## Storable concern
@@ -12,38 +12,46 @@
 * Float
 
 ### Setup
-    class User < ActiveRecord::Base
-      include Concerns::Storable
-
-      storable_field :gender, String, 'male'
-      storable_field :age, Integer
-      storable_field :last_login_at, DateTime
-      storable_field :cool_dude, Boolean, true
-      storable_field :locales, Array, %w(nl)
-      storable_field :birthday, Date
-    end
+```ruby
+class User < ActiveRecord::Base
+  include Concerns::Storable
+
+  storable_field :gender, String, 'male'
+  storable_field :age, Integer
+  storable_field :last_login_at, DateTime
+  storable_field :cool_dude, Boolean, true
+  storable_field :locales, Array, %w(nl)
+  storable_field :birthday, Date
+end
+```
 
 ### Reading values
-    u = User.first
-    u.gender
+```ruby
+u = User.first
+u.gender
 
-    # Which is equal to
-    u.store(:default).gender
+# Which is equal to
+u.store(:default).gender
+```
 
 ### Writing values
-    u = User.first
-    u.gender = 'female'
+```ruby
+u = User.first
+u.gender = 'female'
 
-    # Which is equal to
-    u.store(:default).gender = 'female'
+# Which is equal to
+u.store(:default).gender = 'female'
+```
 
 ### Saving values
-    u = User.first
-    u.gender = 'female'
-    u.save
+```ruby
+u = User.first
+u.gender = 'female'
+u.save
 
-    u.store(:custom).gender = 'unknown'
-    u.store(:custom).save
+u.store(:custom).gender = 'unknown'
+u.store(:custom).save
+```
 
 When you save the parent object (user), all the store collections will
 automatically be saved.
@@ -53,32 +61,42 @@ automatically be saved.
 ## Add tasks to the queue
 You can add tasks to the queue by executing:
 
-    QueuedTask.queue('SomeClass', id: 37, foo: bar)
+```ruby
+QueuedTask.queue('SomeClass', id: 37, foo: bar)
+```
 
 The first paramter specifiecs the string of the class you want to execute the run method from. The second parameter is a hash that contains most scalar values.
 
 ## Example of a task
 
-    class SomeClass
-      def initialize(data)
-        @id = data[:id]
-        @foo = data[:foo]
-      end
+```ruby
+class SomeClass
+  def initialize(data)
+    @id = data[:id]
+    @foo = data[:foo]
+  end
 
-      def run!
-        # add code to run
-      end
-    end
+  def run!
+    # add code to run
+  end
+end
+```
 
 ## Rake task to run as a cronjob
-    rake udongo:queue:process
+```ruby
+rake udongo:queue:process
+```
 
 # Validators
 ## E-mail validator
-    validates :email, email: true
+```ruby
+validates :email, email: true
+```
 
 ## URL validator
-    validates :url, url: true
+```ruby
+validates :url, url: true
+```
 
 
 # Cryptography
@@ -96,16 +114,20 @@ end
 
 ## Syntax
 ### encrypt
-    crypt.encrypt('foo')
-    => "azZiS1lPVU8zV1ljOTdjM2tIM2hTdz09LS1PODc5OEprRmxlMFVMU1lqaDdXK25RPT0=--77983f6f21e31117ac15011fed52dac3fdf776a8"
-    crypt.encrypt('foo')
-    => "bEFwVHVDV1hVc29UUmhJK1RQcllYUT09LS03WkZVYTdkOVhIQnloa1czUkE3L1V3PT0=--3fcc73bd6c11874966bb23811ad48980a44e40e7"
+```ruby
+crypt.encrypt('foo')
+=> "azZiS1lPVU8zV1ljOTdjM2tIM2hTdz09LS1PODc5OEprRmxlMFVMU1lqaDdXK25RPT0=--77983f6f21e31117ac15011fed52dac3fdf776a8"
+crypt.encrypt('foo')
+=> "bEFwVHVDV1hVc29UUmhJK1RQcllYUT09LS03WkZVYTdkOVhIQnloa1czUkE3L1V3PT0=--3fcc73bd6c11874966bb23811ad48980a44e40e7"
+```
 
 ### decrypt
-    crypt.decrypt('azZiS1lPVU8zV1ljOTdjM2tIM2hTdz09LS1PODc5OEprRmxlMFVMU1lqaDdXK25RPT0=--77983f6f21e31117ac15011fed52dac3fdf776a8')
-    => "foo"
-    crypt.decrypt('bEFwVHVDV1hVc29UUmhJK1RQcllYUT09LS03WkZVYTdkOVhIQnloa1czUkE3L1V3PT0=--3fcc73bd6c11874966bb23811ad48980a44e40e7')
-    => "foo"
+```ruby
+crypt.decrypt('azZiS1lPVU8zV1ljOTdjM2tIM2hTdz09LS1PODc5OEprRmxlMFVMU1lqaDdXK25RPT0=--77983f6f21e31117ac15011fed52dac3fdf776a8')
+=> "foo"
+crypt.decrypt('bEFwVHVDV1hVc29UUmhJK1RQcllYUT09LS03WkZVYTdkOVhIQnloa1czUkE3L1V3PT0=--3fcc73bd6c11874966bb23811ad48980a44e40e7')
+=> "foo"
+```
 
 As the examples above illustrate, each subsequent encrypt always returns a different, decryptable hash.
 
@@ -129,10 +151,12 @@ def Udongo::Cryptography
 end
 ```
 
-    crypt = Udongo::Crypt.new(secret: '1234567890123456789012345678901234567890')
-    => #<Udongo::Crypt:0x007fcb1a0f3b50 @options={:secret=>"1234567890123456789012345678901234567890"}>
-    crypt.encrypt('foo')
-    => "YXhsZDV4RlZLTnljclhvM3pKbmV3Zz09LS1ycVR4bEtZemh2UUVKVlBQRnhlcjZRPT0=--f23e37ef7fb94e94cfa8a509f93bdb94e4bc5552"
+```ruby
+crypt = Udongo::Crypt.new(secret: '1234567890123456789012345678901234567890')
+=> #<Udongo::Crypt:0x007fcb1a0f3b50 @options={:secret=>"1234567890123456789012345678901234567890"}>
+crypt.encrypt('foo')
+=> "YXhsZDV4RlZLTnljclhvM3pKbmV3Zz09LS1ycVR4bEtZemh2UUVKVlBQRnhlcjZRPT0=--f23e37ef7fb94e94cfa8a509f93bdb94e4bc5552"
+```
 
 # Datepickers
 There are two custom inputs in Udongo to help handles dates. ```DatePickerInput``` and ```DateRangePickerInput```. Both make use of the [bootstrap-datepicker](http://bootstrap-datepicker.readthedocs.io/en/stable/) JS plugin. You can set/override its defaults through data-attributes, as explained in the docs.
@@ -143,6 +167,7 @@ Applying ```as: :date_picker``` to a simple_form input will bind a datepicker wi
 ```erb
 <%= f.input :date, as: :date_picker %>
 ```
+
 ### DateRangePickerInput
 You can combine two datepicker input fields into a range picker by applying ```as: :date_range_picker``` to 2 different simple_form input fields.
 
@@ -152,3 +177,74 @@ This will link a datepicker to each input with its relevant change listeners bou
 <%= f.input :stop_date, as: :date_range_picker, stop: 'foo' %>
 ```
 The value used in the ```start``` and ```stop``` attributes needs to be the same for two datepicker fields to be combined into a range picker. **If these values don't match, your pickers won't display the intended behaviour.**
+
+# Notifications
+The ```Udongo::Notification``` class provides a generic way to parse action notices without directly interacting with ```I18n```. Its ```translate``` method can be used in a number of ways:
+
+## Without parameters
+```yaml
+nl:
+  b:
+    msg:
+      refreshed: De pagina werd opnieuw ingeladen.
+```
+
+```
+irb(main):001:0> Udongo::Notification.new(:refreshed).translate
+=> "De pagina werd opnieuw ingeladen."
+```
+
+## A string as parameter
+```yaml
+nl:
+  b:
+    admin: Beheerder
+    msg:
+      added: '%{actor} werd toegevoegd.'
+```
+
+```ruby
+irb(main):001:0> Udongo::Notification.new(:added).translate(:admin)
+=> "Beheerder werd toegevoegd."
+```
+
+## Parameter hash
+```yaml
+nl:
+  b:
+    msg:
+      added: '%{name} werd toegevoegd met %{pies} taarten.'
+```
+```ruby
+irb(main):001:0> Udongo::Notification.new(:added).translate(name: 'Dave', pies: 10)
+=> "Dave werd toegevoegd met 10 taarten."
+```
+
+## Notifications in controllers
+```BackendController#translate_notice``` uses ```Udongo::Notification``` to output translated notices. Typically this is used in tandem with redirects. For example in the admins module:
+
+```ruby
+class Backend::AdminsController < BackendController
+  def create
+    redirect_to backend_admins_path, notice: translate_notice(:added, :admin)
+  end
+end
+```
+
+## Configurable form submissions datagrids
+There are two things you can configure in ```config/initializers/udongo.rb``` to affect the form submission datagrids in the CMS:
+* The visible columns in the datagrid
+* Which fields the filter should have
+
+```ruby
+Udongo.configure do |config|
+  config.form_submissions = {
+    contest: {
+      filter: %w(email last_name),
+      datagrid_fields: %w(last_name first_name telephone)
+    }
+  }
+end
+```
+
+Note that the ```contest``` in the config above maps to a ```Form#identifier```. This way you can have different configurations per submissions page.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: udongo
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Davy Hellemans
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -458,6 +458,7 @@ files:
 - app/assets/javascripts/backend/application.js
 - app/assets/javascripts/backend/bootstrap.js
 - app/assets/javascripts/backend/datepickers.js
+- app/assets/javascripts/backend/flexible_content.js
 - app/assets/javascripts/backend/general.js
 - app/assets/javascripts/backend/pages.js
 - app/assets/javascripts/backend/plugins/autocomplete.js
@@ -485,6 +486,9 @@ files:
 - app/controllers/backend/dashboard_controller.rb
 - app/controllers/backend/email_templates_controller.rb
 - app/controllers/backend/emails_controller.rb
+- app/controllers/backend/forms/base_controller.rb
+- app/controllers/backend/forms/submissions_controller.rb
+- app/controllers/backend/forms_controller.rb
 - app/controllers/backend/navigation/items_controller.rb
 - app/controllers/backend/navigations_controller.rb
 - app/controllers/backend/pages_controller.rb
@@ -501,10 +505,15 @@ files:
 - app/controllers/concerns/backend/translatable_controller.rb
 - app/controllers/concerns/pagination_controller.rb
 - app/controllers/redirects_controller.rb
+- app/decorators/application_decorator.rb
 - app/decorators/content_image_decorator.rb
+- app/decorators/content_row_decorator.rb
 - app/decorators/content_text_decorator.rb
+- app/decorators/form_decorator.rb
+- app/decorators/form_submission_decorator.rb
 - app/decorators/navigation_item_decorator.rb
 - app/decorators/page_decorator.rb
+- app/decorators/pagination_decorator.rb
 - app/decorators/redirect_decorator.rb
 - app/decorators/snippet_decorator.rb
 - app/forms/backend/email_template_translation_form.rb
@@ -571,6 +580,7 @@ files:
 - app/models/setting.rb
 - app/models/snippet.rb
 - app/models/store.rb
+- app/models/store_with_file.rb
 - app/models/tag.rb
 - app/models/tagged_item.rb
 - app/uploaders/ckeditor_attachment_file_uploader.rb
@@ -605,6 +615,9 @@ files:
 - app/views/backend/email_templates/new.html.erb
 - app/views/backend/emails/index.html.erb
 - app/views/backend/emails/show.html.erb
+- app/views/backend/forms/index.html.erb
+- app/views/backend/forms/submissions/_filter.html.erb
+- app/views/backend/forms/submissions/index.html.erb
 - app/views/backend/navigation/items/_form.html.erb
 - app/views/backend/navigation/items/_tabs.html.erb
 - app/views/backend/navigation/items/edit.html.erb
@@ -709,6 +722,7 @@ files:
 - db/migrate/20160601111729_add_collection_to_store.rb
 - db/migrate/20160601115312_remove_klass_from_stores.rb
 - db/migrate/20160601200049_remove_translation_model.rb
+- db/migrate/20160711114156_add_description_to_forms.rb
 - lib/generators/udongo/form/form_generator.rb
 - lib/generators/udongo/form/templates/form.rb
 - lib/tasks/task_extras.rb
@@ -719,15 +733,23 @@ files:
 - lib/udongo/assets/precompiler.rb
 - lib/udongo/breadcrumb.rb
 - lib/udongo/config.rb
+- lib/udongo/configs/forms.rb
 - lib/udongo/crypt.rb
 - lib/udongo/cryptography.rb
 - lib/udongo/email_vars/address.rb
 - lib/udongo/email_vars/form_submission.rb
 - lib/udongo/email_vars_parser.rb
 - lib/udongo/engine.rb
+- lib/udongo/flexible_content/column_width_calculator.rb
+- lib/udongo/form.rb
+- lib/udongo/forms/config.rb
+- lib/udongo/forms/submission_datagrid.rb
+- lib/udongo/forms/submission_filter.rb
 - lib/udongo/meta_info.rb
+- lib/udongo/notification.rb
 - lib/udongo/object_path.rb
 - lib/udongo/version.rb
+- lib/udongo/will_paginate/options.rb
 - lib/udongo/will_paginate/renderer.rb
 - readme.md
 - vendor/assets/images/jstree/default/32px.png