schedulable 0.0.6 → 0.0.7

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTFlNjE4MmQ1ZGVhZjdlMWEyZGJlMGYzZjhmZDUzZGQ4ZTVhOTU3ZQ==
-  data.tar.gz: !binary |-
-    OTA4MjU5YjI3NzBjZWQ1N2QwMzRiMGUwOTlhN2RkMzdhODAyNTJlYg==
+SHA1:
+  metadata.gz: 2f7a4518050fa937ff52f0e063aaaadba2947c90
+  data.tar.gz: c3b07ace00ddf8dca91141e3c9042f2389acf033
 SHA512:
-  metadata.gz: !binary |-
-    NGFlY2QyMjBjOTViOWY2YjAyOGYzYTJkN2Q4Y2U2Zjg1NTJlNTNhM2RiZmM4
-    MTUzYzAyNTZlNGYzZDA1ZGQ0NWVjZmNhOTlkZDg2ZjI1NDExMTUyMWNmMGNi
-    NDEzNGJkMzc2MjE3NGVjODJjZDk3ODdmZDk5ZmY5ODNmODNjZTE=
-  data.tar.gz: !binary |-
-    NzMyYzQ1NTdjZGU4NjJkNTEyMjFlZTQ2NjcxNDg0YTAyMDY4ZjcxY2JmM2Fi
-    ZjFjMWRkMjQwYWEyY2JkZjhiYTYxN2I2MDc0YWUyMDk1NmMwOGE0MjJlODc1
-    MTRlYWZhMjcxMzNhZWFlNGYyZTY2MjcyZWMyNTFhMGUzMDAxMzA=
+  metadata.gz: 5be2519e0114ea58aa2180ecf6373b62aab37f730baa32e0afa01e5ddfc747f7733dd447e862ad448efccb6d5b6d9aacfe1d60e6b2f881cc416cedc1a4a73b13
+  data.tar.gz: 16a5641da65cb17518bb19e9f8219a9300e0a6afa9b813928c58345d02876bdd52ab14bc01971b2ac76474256b3fceaba61843e665c917932cec24a9c195a2eb

data/README.md

@@ -3,21 +3,23 @@ schedulable
 
 Handling recurring events in rails. 
 
+### Install
 
-The schedulable plugin depends on the ice_cube scheduling-library:
-```
+Put the following into your Gemfile and run `bundle install`
+```cli
 gem 'ice_cube'
+gem 'schedulable'
 ```
 
 Install schedule migration and model
-```
+```cli
 rails g schedulable:install
 ```
 
 ### Basic Usage
 
-Create your event model
-```
+Create an event model
+```cli
 rails g scaffold Event name:string
 ```
 
@@ -28,7 +30,7 @@ class Event < ActiveRecord::Base
   acts_as_schedulable
 end
 ```
-This will add an association named 'schedule' that holds the schedule information. 
+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. 
 
@@ -65,19 +67,36 @@ The schedule object respects the following attributes:
 </table>
 
 #### SimpleForm
-A custom input for simple_form is provided with the plugin
-```
+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`.
+
+```cli
 rails g schedulable:simple_form
 ```
 
-```
--# app/views/events/_form.html.haml
-.form-inputs
-  = f.input :name
-  = f.input :schedule, as: :schedule
+```ruby
+<%# app/views/events/_form.html.erb %>
+<%= simple_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.input :schedule, as: :schedule %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+  
+<% end %>
+
 ```
 
 #### Strong parameters
+
 ```
 # app/controllers/event_controller.rb
 def event_params
@@ -88,24 +107,54 @@ end
 ### IceCube
 The schedulable plugin uses ice_cube for calculating occurrences. 
 You can access ice_cube-methods 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 %> 
+  <%= @event.schedule %>
+</p>
+```
+
 ```
 # prints all occurrences of the event until one year from now
 puts @event.schedule.occurrences(Time.now + 1.year)
 # export to ical
 puts @event.schedule.to_ical
 ```
-See https://github.com/seejohnrun/ice_cube for more information.
+See [IceCube](https://github.com/seejohnrun/ice_cube) for more information.
+
+### 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).
+
+#### Localize Schedulable
+Use the locale-generator to create a .yml-file containing schedulable messages in english:
+```cli
+rails g schedulable:locale en
+```
 
-### Event occurrences
+Schedulable has also bundled messages in german. Use `de` as identifier.
+
+#### 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 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. 
 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
 rails g model EventOccurrence event_id:integer date:datetime
 ```
 
-```
+```ruby
 # app/models/event_occurrence.rb
 class EventOccurrence < ActiveRecord::Base
   belongs_to :event
@@ -135,20 +184,30 @@ See notes on configuration.
 #### 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. 
-```
+
+```cli
 rake schedulable:build_occurrences
 ```
-You may add the task to crontab. 
+
+You may add this task to crontab. 
+
+##### Using 'whenever' to schedule build of occurrences
+
 With the 'whenever' gem this can be easily achieved. 
+
 ```
 gem 'whenever', :require => false
 ```
-Create the 'whenever'-configuration file:
-```
+
+Generate the 'whenever'-configuration file:
+
+```cli
 wheneverize .
 ```
+
 Open up the file 'config/schedule.rb' and add the job:
-```
+
+```ruby
 set :environment, "development"
 set :output, {:error => "log/cron_error_log.log", :standard => "log/cron_log.log"}
 
@@ -156,18 +215,23 @@ every 1.day do
   rake "schedulable:build_occurrences"
 end
 ```
-Write to the crontab:
-```
+
+Write to crontab:
+
+```cli
 whenever -w
 ```
 
 ### Configuration
 Generate the configuration file
-```
+
+```cli
 rails g schedulable:config
 ```
+
 Open 'config/initializers/schedulable.rb' and edit options as you need:
-```
+
+```ruby
 Schedulable.configure do |config|
   config.max_build_count = 0
   config.max_build_period = 1.year

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

@@ -2,7 +2,11 @@ class ScheduleInput < SimpleForm::Inputs::Base
   
   
   def input
- 
+    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
@@ -10,7 +14,6 @@ class ScheduleInput < SimpleForm::Inputs::Base
     input_options[:until] = !input_options[:until].nil? ? input_options[:until] : true
     input_options[:count] = !input_options[:count].nil? ? input_options[:count] : true
     
-    
     @builder.simple_fields_for(:schedule, @builder.object.schedule || @builder.object.build_schedule) do |b|
       
       b.template.content_tag("div", {id: b.object_name.to_s.gsub(/\]\[|[^-a-zA-Z0-9:.]/,"_").sub(/_$/,"")}) do
@@ -22,34 +25,33 @@ class ScheduleInput < SimpleForm::Inputs::Base
         end <<
         
         template.content_tag("div", {data: {group: 'weekly'}}) do
-          b.input :days, collection: Time::DAYS_INTO_WEEK.invert.values, label_method: lambda { |v| I18n.t("date.day_names")[Time::DAYS_INTO_WEEK[v]] || v.capitalize }, as: :check_boxes
+          b.input :days, collection: weekdays, label_method: lambda { |v| ("&nbsp;" + daylabels[v]).html_safe}, as: :check_boxes
         end <<
         
         template.content_tag("div", {data: {group: 'monthly'}}) do
+          
           b.simple_fields_for :day_of_week, OpenStruct.new(b.object.day_of_week || {}) do |db|
-            
-            template.content_tag("div", class: 'form-group') do
-              
-              db.label(I18n.t("activerecord.attributes.schedule.day_of_week"), required: false) <<
-              
+            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    
+                    end
                   }
                 end <<
-                Time::DAYS_INTO_WEEK.invert.values.reduce(''.html_safe) { | x, weekday | 
+                weekdays.reduce(''.html_safe) do | x, weekday | 
                   x << template.content_tag("tr") do 
                     template.content_tag("td") do
-                      db.label I18n.t("date.day_names")[Time::DAYS_INTO_WEEK[weekday]] || weekday, required: false
+                      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)) 
                   end
-                }
-              end
+                end
+              end <<
+              b.error(:day_of_week)
             end
           end
         end << 
@@ -75,7 +77,7 @@ class ScheduleInput < SimpleForm::Inputs::Base
       end <<
       
       template.javascript_tag(
-        "(function() {" << 
+        "$(function() {" << 
         "  var container = $(\"*[id='#{b.object_name.to_s.gsub(/\]\[|[^-a-zA-Z0-9:.]/,"_").sub(/_$/,"")}']\");" << 
         "  var select = container.find(\"select[name*='rule']\");" << 
         "  function update() {" <<
@@ -91,7 +93,7 @@ class ScheduleInput < SimpleForm::Inputs::Base
         "  }" << 
         "  select.on('change', update);" <<
         "  update.call(select[0]);" << 
-        "})()"
+        "})"
       )
       
       

data/lib/generators/schedulable/templates/locale/schedulable.de.yml

@@ -26,7 +26,4 @@ de:
       singular: Einmalig
       monthly: Monatlich
       weekly: Wöchentlich
-      daily: Täglich
-      
-      
-    
+      daily: Täglich

data/lib/generators/schedulable/templates/locale/schedulable.en.yml

@@ -26,7 +26,4 @@ en:
       singular: Singular
       monthly: Monthly
       weekly: Weekly
-      daily: Daily
-      
-      
-    
+      daily: Daily

data/lib/schedulable/version.rb

@@ -1,3 +1,3 @@
 module Schedulable
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: schedulable
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Rafael Nowrotek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.3
 - !ruby/object:Gem::Dependency
   name: ice_cube
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Handling recurring events in rails.
@@ -45,6 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - lib/generators/schedulable/config_generator.rb
 - lib/generators/schedulable/install_generator.rb
 - lib/generators/schedulable/locale_generator.rb
@@ -58,15 +61,12 @@ files:
 - lib/generators/schedulable/templates/migrations/create_schedules.rb
 - lib/generators/schedulable/templates/models/occurrence.erb
 - lib/generators/schedulable/templates/models/schedule.rb
+- lib/schedulable.rb
 - lib/schedulable/acts_as_schedulable.rb
 - lib/schedulable/railtie.rb
 - lib/schedulable/schedule_support.rb
 - lib/schedulable/version.rb
-- lib/schedulable.rb
 - lib/tasks/schedulable_tasks.rake
-- MIT-LICENSE
-- Rakefile
-- README.md
 homepage: http://github.com/benignware
 licenses: []
 metadata: {}
@@ -76,17 +76,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Handling recurring events in rails.