schedulable 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f7a4518050fa937ff52f0e063aaaadba2947c90
-  data.tar.gz: c3b07ace00ddf8dca91141e3c9042f2389acf033
+  metadata.gz: cf160baa485b91e6566ffb4a3d4914058237f634
+  data.tar.gz: edfc6d3c758cbdef642e633a1a32869f6a386327
 SHA512:
-  metadata.gz: 5be2519e0114ea58aa2180ecf6373b62aab37f730baa32e0afa01e5ddfc747f7733dd447e862ad448efccb6d5b6d9aacfe1d60e6b2f881cc416cedc1a4a73b13
-  data.tar.gz: 16a5641da65cb17518bb19e9f8219a9300e0a6afa9b813928c58345d02876bdd52ab14bc01971b2ac76474256b3fceaba61843e665c917932cec24a9c195a2eb
+  metadata.gz: 555836580530752b1eecf9cf85cf9b8f7a44f5d12fb62254555930f895608d7a644a3f555a5c98e09b1fdb366466733952eea3afd31d053a4567406d074145c7
+  data.tar.gz: a47bd73ac68eeff77a1dcecbcebab3d32c4e41a04fe429efe13d862d54397475f08f50f8a51ab3a2a8755e343c1d65090d031ed95b3904ca7593ec4fd98741a4

data/README.md

@@ -1,9 +1,10 @@
 schedulable
 ===========
 
-Handling recurring events in rails. 
+> Handling recurring events in rails. 
 
-### Install
+
+## Install
 
 Put the following into your Gemfile and run `bundle install`
 ```cli
@@ -16,7 +17,7 @@ Install schedule migration and model
 rails g schedulable:install
 ```
 
-### Basic Usage
+## Basic Usage
 
 Create an event model
 ```cli
@@ -27,15 +28,13 @@ Configure your model to be schedulable:
 ```
 # app/models/event.rb
 class Event < ActiveRecord::Base
-  acts_as_schedulable
+  acts_as_schedulable :schedule
 end
 ```
 This will add an association to the model named 'schedule' which holds the schedule information. 
 
-Now you're ready to setup form fields for the schedule association using the fields_for-form_helper. 
-
-### Attributes
-The schedule object respects the following attributes:
+### Schedule Model
+The schedule-object respects the following attributes.
 <table>
   <tr>
     <th>Name</th><th>Type</th><th>Description</th>
@@ -50,10 +49,10 @@ The schedule object respects the following attributes:
     <td>time</td><td>Time</td><td>The time-attribute is used for singular events and also as starttime of the schedule</td>
   </tr>
   <tr>
-    <td>days</td><td>Array</td><td>An array of weekday-names, i.e. ['monday', 'wednesday']</td>
+    <td>day</td><td>Array</td><td>Day of week. An array of weekday-names, i.e. ['monday', 'wednesday']</td>
   </tr>
   <tr>
-    <td>day_of_week</td><td>Hash</td><td>A hash of weekday-names, containing arrays with indices, i.e. {:monday => [1, -1]} ('every first and last monday in month')</td>
+    <td>day_of_week</td><td>Hash</td><td>Day of nth week. A hash of weekday-names, containing arrays with indices, i.e. {:monday => [1, -1]} ('every first and last monday in month')</td>
   </tr>
   <tr>
     <td>interval</td><td>Integer</td><td>Specifies the interval of the recurring rule, i.e. every two weeks</td>
@@ -66,8 +65,83 @@ The schedule object respects the following attributes:
   </tr>
 </table>
 
-#### SimpleForm
-A custom input for simple_form is provided with the plugin. Make sure, you installed [SimpleForm](https://github.com/plataformatec/simple_form) and executed `rails generate simple_form:install`.
+## Forms
+
+Use schedulable's built-in helpers to setup your form.
+
+### FormBuilder
+
+Schedulable extends FormBuilder with a 'schedule_select'-helper and should therefore seamlessly integrate it with your existing views:
+
+```erb
+<%# app/views/events/_form.html.erb %>
+<%= form_for(@event) do |f| %>
+
+  <div class="field">
+    <%= f.label :name %><br>
+    <%= f.text_field :name %>
+  </div>
+  
+  <div class="field">
+    <%= f.label :schedule %><br>
+    <%= f.schedule_select :schedule %>
+  </div>
+  
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>
+```
+
+#### Customize markup
+You can customize the generated markup by providing a hash of html-attributes as `style`-option. For wrappers, also provide a `tag`-attribute.
+* field_html
+* input_html
+* input_wrapper
+* label_html
+* label_wrapper
+* number_field_html
+* number_field_wrapper
+* date_select_html
+* date_select_wrapper
+* collection_select_html
+* collection_select_wrapper
+* collection_check_boxes_item_html
+* collection_check_boxes_item_wrapper
+
+#### Integrate with Bootstrap
+
+The schedulable-formhelper has built-in-support for Bootstrap. Simply point the style-option of schedule_input to `bootstrap` or set it as default in config. 
+
+```erb
+
+<%= f.schedule_select :schedule, style: :bootstrap %>
+```
+
+#### Options
+
+<table>
+  <tr>
+    <th>Name</th><th>Type</th><th>Description</th>
+  </tr>
+  <tr>
+  <tr>
+    <td>count</td><td>Boolean</td><td>Specifies whether to show 'count'-field</td>
+  </tr>
+  <tr>
+    <td>interval</td><td>Boolean</td><td>Specifies whether to show 'interval'-field</td>
+  </tr>
+  <tr>
+    <td>style</td><td>Hash</td><td>Specifies a hash of options to customize markup. By providing a string, you can point to a prefined set of options. Built-in styles are :bootstrap and :default.
+  </tr>
+  <tr>
+    <td>until</td><td>Boolean</td><td>Specifies whether to show 'until'-field</td>
+  </tr>
+</table>
+
+### SimpleForm
+Also provided with the plugin is a custom input for simple_form. Make sure, you installed [SimpleForm](https://github.com/plataformatec/simple_form) and executed `rails generate simple_form:install`.
+
 
 ```cli
 rails g schedulable:simple_form
@@ -92,11 +166,57 @@ rails g schedulable:simple_form
   </div>
   
 <% end %>
+```
 
+#### Integrate with Bootstrap
+
+Simple Form has built-in support for Bootstrap as of version 3.0.0. 
+At time of writing it requires some a little extra portion of configuration to make it look as expected:
+
+```ruby
+# config/initializers/simple_form_bootstrap.rb
+
+# Inline date_select-wrapper for Bootstrap
+config.wrappers :horizontal_select_date, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+  b.use :html5
+  b.optional :readonly
+  b.use :label, class: 'control-label'
+  b.wrapper tag: 'div', class: 'form-inline' do |ba|
+    ba.use :input, class: 'form-control'
+    ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+    ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+  end
+end
+
+# Include date_select-wrapper in mappings
+config.wrapper_mappings = {
+  datetime: :horizontal_select_date,
+  date: :horizontal_select_date,
+  time: :horizontal_select_date
+}
 ```
 
-#### Strong parameters
+#### Options
+
+<table>
+  <tr>
+    <th>Name</th><th>Type</th><th>Description</th>
+  </tr>
+  <tr>
+  <tr>
+    <td>count</td><td>Boolean</td><td>Specifies whether to show 'count'-field</td>
+  </tr>
+  <tr>
+    <td>interval</td><td>Boolean</td><td>Specifies whether to show 'interval'-field</td>
+  </tr>
+  <tr>
+    <td>until</td><td>Boolean</td><td>Specifies whether to show 'until'-field</td>
+  </tr>
+</table>
+
+### Sanitize parameters
 
+Add schedule-attributes to the list of strong parameters in your controller:
 ```
 # app/controllers/event_controller.rb
 def event_params
@@ -104,50 +224,52 @@ def event_params
 end
 ```
 
-### IceCube
-The schedulable plugin uses ice_cube for calculating occurrences. 
-You can access ice_cube-methods via the schedule association:
+## Accessing IceCube
+You can access ice_cube-methods directly via the schedule association:
 
 ```ruby
 <%# app/views/events/show.html.erb %>
 <p>
   <strong>Schedule:</strong>
-  <%# prints out a human-friendly description of the schedule, such as %> 
+  <%# Prints out a human-friendly description of the schedule, such as %> 
   <%= @event.schedule %>
 </p>
 ```
 
 ```
-# prints all occurrences of the event until one year from now
+# Prints all occurrences of the event until one year from now
 puts @event.schedule.occurrences(Time.now + 1.year)
-# export to ical
+# Export to ical
 puts @event.schedule.to_ical
 ```
 See [IceCube](https://github.com/seejohnrun/ice_cube) for more information.
 
-### Internationalization
+## Internationalization
 
-At first you need to make sure you included all neccessary datetime translations. 
-A basic setup can be found [here](https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale).
+Schedulable is bundled with translations in english and german which will be automatically initialized with your app.
+You can customize these messages by running the locale generator and edit the created yml-files:
 
-#### Localize Schedulable
-Use the locale-generator to create a .yml-file containing schedulable messages in english:
 ```cli
-rails g schedulable:locale en
+rails g schedulable:locale de
 ```
 
-Schedulable has also bundled messages in german. Use `de` as identifier.
+### Date- and Time-Messages
+Appropriate datetime translations should be included.
+Basic setup for many languages can be found here:
+[https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale](https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale).
+
+
+### IceCube-Messages
+An internationalization-branch of ice_cube can be found here: 
+[https://github.com/joelmeyerhamme/ice_cube](https://github.com/joelmeyerhamme/ice_cube):
 
-#### Localize Ice-Cube
-Internationalization of ice-cube itself can be integrated by using [this fork](https://github.com/joelmeyerhamme/ice_cube):
 ```ruby
 gem 'ice_cube', git: 'git://github.com/joelmeyerhamme/ice_cube.git', branch: 'international' 
 ```
 
+## Persist Occurrences
 
-### Persist event occurrences
-We need to have the occurrences persisted because we want to query the database for all occurrences of all instances of an event model or need to add additional attributes and functionality, such as allowing users to attend to a specific occurrence of an event.
-The schedulable gem handles this for you. 
+Schedulable allows for persisting occurrences and associate them with your model. 
 Your occurrence model must include an attribute of type 'datetime' with name 'date' as well as a reference to your event model to setup up the association properly:  
 
 ```ruby
@@ -161,19 +283,22 @@ class EventOccurrence < ActiveRecord::Base
 end
 ```
 
-Then you can simply declare your occurrences with the acts_as_schedule-method like this:
+Declare occurrence-model with the acts_as_schedule-method like this:
 ```
 # app/models/event.rb
 class Event < ActiveRecord::Base
-  acts_as_schedulable occurrences: :event_occurrences
+  acts_as_schedulable :schedule, occurrences: :event_occurrences
 end
 ```
-This will add a has_many-association with the name 'event_occurences' to your event-model. 
-Instances of remaining occurrences are built when the schedule is saved. 
-If the schedule has changed, the occurrences will be rebuilt if dates have also changed. Otherwise the time of the occurrence record will be adjusted to the new time.
-As in real life, previous occurrences will always stay untouched.
 
-#### Terminating and non-terminating events
+This will add a `event_occurrences`-association to the model as well as `remaining_event_occurrences` and `previous_event_occurrences`-associations.
+
+Instances of remaining occurrences are persisted when the parent-model is saved.
+ 
+Occurrences records will be reused if their datetime matches the saved schedule. 
+Previous occurrences stay untouched.
+
+### Terminating and non-terminating events
 An event is terminating if an until- or count-attribute has been specified. 
 Since non-terminating events have infinite occurrences, we cannot build all occurrences at once ;-)
 So we need to limit the number of occurrences in the database. 
@@ -181,7 +306,7 @@ By default this will be one year from now.
 This can be configured via the 'build_max_count' and 'build_max_period'-options. 
 See notes on configuration. 
 
-#### Automate build of occurrences
+### Automate build of occurrences
 Since we cannot build all occurrences at once, we will need a task that adds occurrences as time goes by. 
 Schedulable comes with a rake-task that performs an update on all scheduled occurrences. 
 
@@ -191,7 +316,7 @@ rake schedulable:build_occurrences
 
 You may add this task to crontab. 
 
-##### Using 'whenever' to schedule build of occurrences
+#### Using 'whenever' to schedule build of occurrences
 
 With the 'whenever' gem this can be easily achieved. 
 
@@ -222,18 +347,25 @@ Write to crontab:
 whenever -w
 ```
 
-### Configuration
+## Configuration
 Generate the configuration file
 
 ```cli
 rails g schedulable:config
 ```
 
-Open 'config/initializers/schedulable.rb' and edit options as you need:
+Open 'config/initializers/schedulable.rb' and edit options as needed:
 
 ```ruby
 Schedulable.configure do |config|
   config.max_build_count = 0
   config.max_build_period = 1.year
+  config.form_helper = {
+    style: :default
+  }
 end
 ```
+
+
+## Changelog
+See the [Changelog](CHANGELOG.md) for recent enhancements, bugfixes and deprecations.

data/Rakefile

@@ -21,6 +21,9 @@ Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'

data/config/locales/de.yml

@@ -0,0 +1,29 @@
+de: 
+  model:
+    schedule: 'Zeitplan'
+    
+  activerecord:
+    attributes:
+      schedule: 
+        name: Name
+        rule: Regel
+        time: Uhrzeit
+        date: Datum
+        day: Wochentage
+        day_of_week: "Wochentage im Monat"
+        interval: Intervall
+        until: Wiederholen bis
+        count: Anzahl Wiederholungen
+        
+  schedulable: 
+    monthly_week_names:
+      1st: '1.'
+      2nd: '2.'
+      3rd: '3.'
+      4th: '4.'
+      last: 'L'
+    rules: 
+      singular: Einmalig
+      monthly: Monatlich
+      weekly: Wöchentlich
+      daily: Täglich

data/{lib/generators/schedulable/templates/locale/schedulable.en.yml → config/locales/en.yml}

@@ -10,8 +10,8 @@ en:
         time: Time
         date: Date
         rule: Rule
-        days: Weekdays
-        day_of_week: Weekdays
+        day: Weekdays
+        day_of_week: Weekdays of nth week
         until: Repeat until
         count: Repetition count
         

data/lib/generators/schedulable/locale_generator.rb

@@ -8,7 +8,7 @@ module Schedulable
       
       def create_locale
         puts 'install locale'
-        template "locale/schedulable.#{locale}.yml", "config/locales/schedulable.#{locale}.yml"
+        template "../../../../config/locales/#{locale}.yml", "config/locales/schedulable.#{locale}.yml"
       end
       
     end

data/lib/generators/schedulable/templates/config/schedulable.rb

@@ -1,4 +1,7 @@
 Schedulable.configure do |config|
-  config.max_build_count = 0
-  config.max_build_period = 1.year
+  config.max_count = 0
+  config.max_until = 1.year
+  config.form_helper = {
+    style: :default
+  }
 end

data/lib/generators/schedulable/templates/inputs/schedule_input.rb

@@ -1,31 +1,52 @@
 class ScheduleInput < SimpleForm::Inputs::Base
   
-  
-  def input
+  def input(wrapper_options)
+    
+    
+    # I18n
     weekdays = Date::DAYNAMES.map(&:downcase)
-    daynames = I18n.t('date.day_names')
-    daylabels = Hash[weekdays.zip(daynames)]
     weekdays = weekdays.slice(1..7) << weekdays.slice(0)
-      
-    input_html_options[:type] ||= input_type if html5?
     
-    # options
-    input_options[:interval] = !input_options[:interval].nil? ? input_options[:interval] : true
-    input_options[:until] = !input_options[:until].nil? ? input_options[:until] : true
-    input_options[:count] = !input_options[:count].nil? ? input_options[:count] : true
+    day_names = I18n.t('date.day_names', default: "")
+    day_names = day_names.blank? ? weekdays.map { |day| day.capitalize } : day_names.slice(1..7) << day_names.slice(0)
+    day_labels = Hash[weekdays.zip(day_names)]
+    
+    # Pass in default month names when missing in translations
+    month_names = I18n.t('date.month_names', default: "")
+    month_names = month_names.blank? ? Date::MONTHNAMES : month_names
+
+    # Pass in default order when missing in translations
+    date_order = I18n.t('date.order', default: "")
+    date_order = date_order.blank? ? [:year, :month, :day] : date_order 
+    
+    date_options = {
+      order: date_order,
+      use_month_names: month_names
+    }
     
+    # Input html options
+    input_html_options[:type] ||= input_type if html5?
+    
+    # Input options
+    input_options[:interval] = !input_options[:interval].nil? ? input_options[:interval] : false
+    input_options[:until] = !input_options[:until].nil? ? input_options[:until] : false
+    input_options[:count] = !input_options[:count].nil? ? input_options[:count] : false
+
     @builder.simple_fields_for(:schedule, @builder.object.schedule || @builder.object.build_schedule) do |b|
+
+      # Javascript element id
+      field_id = b.object_name.to_s.gsub(/\]\[|[^-a-zA-Z0-9:.]/,"_").sub(/_$/,"")
       
-      b.template.content_tag("div", {id: b.object_name.to_s.gsub(/\]\[|[^-a-zA-Z0-9:.]/,"_").sub(/_$/,"")}) do
+      b.template.content_tag("div", {id: field_id}) do
         
-        b.input(:rule, collection: ['singular', 'daily', 'weekly', 'monthly'], label_method: lambda { |i| I18n.t("schedulable.rules.#{i}") || i.capitalize }, label: false) << 
+        b.input(:rule, collection: ['singular', 'daily', 'weekly', 'monthly'], label_method: lambda { |v| I18n.t("schedulable.rules.#{v}", default: v.capitalize) }, label: false, include_blank: false) << 
         
         template.content_tag("div", {data: {group: 'singular'}}) do
-          b.input :date
+          b.input :date, date_options
         end <<
         
         template.content_tag("div", {data: {group: 'weekly'}}) do
-          b.input :days, collection: weekdays, label_method: lambda { |v| ("&nbsp;" + daylabels[v]).html_safe}, as: :check_boxes
+          b.input :day, collection: weekdays, label_method: lambda { |v| ("&nbsp;" + day_labels[v]).html_safe}, boolean_style: :nested, as: :check_boxes
         end <<
         
         template.content_tag("div", {data: {group: 'monthly'}}) do
@@ -33,70 +54,79 @@ class ScheduleInput < SimpleForm::Inputs::Base
           b.simple_fields_for :day_of_week, OpenStruct.new(b.object.day_of_week || {}) do |db|
             template.content_tag("div", class: 'form-group' + (b.object.errors[:day_of_week].any? ? " has-error" : "")) do
               b.label(:day_of_week, error: true) << 
-              template.content_tag("table", style: 'min-width: 280px') do
-                template.content_tag("tr") do
-                  template.content_tag("td") <<
-                  ['1st', '2nd', '3rd', '4th', 'last'].reduce(''.html_safe) { | x, item | 
-                    x << template.content_tag("td") do 
-                       db.label(I18n.t("schedulable.monthly_week_names.#{item}") || item, required: false)
-                    end
+              template.content_tag("div", nil, style: 'min-width: 280px; display: table') do
+                template.content_tag("div", nil, style: 'display: table-row') do
+                  template.content_tag("span", nil, style: 'display: table-cell;') <<
+                  ['1st', '2nd', '3rd', '4th', 'last'].reduce(''.html_safe) { | content, item | 
+                    content << template.content_tag("span", I18n.t("schedulable.monthly_week_names.#{item}", default: item.to_s), style: 'display: table-cell; text-align: center')
                   }
                 end <<
-                weekdays.reduce(''.html_safe) do | x, weekday | 
-                  x << template.content_tag("tr") do 
-                    template.content_tag("td") do
-                      db.label daylabels[weekday] || weekday, required: false
-                    end << 
-                    db.collection_check_boxes(weekday.to_sym, [1, 2, 3, 4, -1], lambda { |i| i} , lambda { |i| "&nbsp;".html_safe}, item_wrapper_tag: :td, checked: db.object.send(weekday)) 
+                weekdays.reduce(''.html_safe) do | content, weekday | 
+                  content << template.content_tag("div", nil, style: 'display: table-row') do 
+                    template.content_tag("span", day_labels[weekday] || weekday, style: 'display: table-cell') <<
+                    db.collection_check_boxes(weekday.to_sym, [1, 2, 3, 4, -1], lambda { |i| i} , lambda { |i| "&nbsp;".html_safe}, checked: db.object.send(weekday), item_wrapper_tag: nil) do |cb|
+                      template.content_tag("span", cb.check_box(), style: 'display: table-cell; text-align: center')
+                    end 
                   end
                 end
-              end <<
+              end << 
               b.error(:day_of_week)
             end
           end
         end << 
         
-        template.content_tag("div", {data: {group: 'singular,daily,weekly,monthly'}}) do
-          b.input :time
+        template.content_tag("div", data: {group: 'singular,daily,weekly,monthly'}) do
+          b.input :time, date_options
         end << 
         
-        (template.content_tag("div", {data: {group: 'daily,weekly,monthly'}}) do
-          b.input :interval
-        end if input_options[:interval]) <<
+        (if input_options[:interval]
+          template.content_tag("div", data: {group: 'daily,weekly,monthly'}) do
+            b.input :interval
+          end
+        else
+          b.input(:interval, as: :hidden, input_html: {value: 1})
+        end) <<
         
-        (template.content_tag("div", {data: {group: 'daily,weekly,monthly'}}) do
-          b.input :until
-        end if input_options[:until]) <<
+        (if input_options[:until]
+          template.content_tag("div", data: {group: 'daily,weekly,monthly'}) do
+            b.input :until, date_options
+          end
+        else
+          b.input(:until, as: :hidden, input_html: {value: nil})
+        end) <<
         
-        (template.content_tag("div", {data: {group: 'daily,weekly,monthly'}}) do
-          b.input :count
-        end if input_options[:count])
+        if input_options[:count]
+          template.content_tag("div", data: {group: 'daily,weekly,monthly'}) do
+            b.input :count
+          end
+        else
+           b.input(:count, as: :hidden, input_html: {value: 0})
+        end
         
         
         
       end <<
       
       template.javascript_tag(
-        "$(function() {" << 
-        "  var container = $(\"*[id='#{b.object_name.to_s.gsub(/\]\[|[^-a-zA-Z0-9:.]/,"_").sub(/_$/,"")}']\");" << 
-        "  var select = container.find(\"select[name*='rule']\");" << 
+        "(function() {" << 
+        "  var container = document.querySelectorAll('##{field_id}'); container = container[container.length - 1]; " << 
+        "  var select = container.querySelector(\"select[name*='rule']\"); " << 
         "  function update() {" <<
         "    var value = this.value;" << 
-        "    container.find(\"*[data-group]\").each(function() {" <<
-        "      var groups = $(this).data('group').split(',');" <<
-        "      if ($.inArray(value, groups) >= 0) {" <<
-        "        $(this).css('display', '');" << 
+        "    [].slice.call(container.querySelectorAll(\"*[data-group]\")).forEach(function(elem) { " <<
+        "      var groups = elem.getAttribute('data-group').split(',');" <<
+        "      if (groups.indexOf(value) >= 0) {" <<
+        "        elem.style.display = ''" << 
         "      } else {" <<
-        "        $(this).css('display', 'none');" << 
+        "        elem.style.display = 'none'" << 
         "      }" <<
         "    });" <<
         "  }" << 
-        "  select.on('change', update);" <<
-        "  update.call(select[0]);" << 
-        "})"
+        "  if (jQuery) { jQuery(select).on('change', update); } else { select.addEventListener('change', update); }" <<
+        "  update.call(select);" << 
+        "})()"
       )
       
-      
     end