acts_as_full_calendar_event 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be37c3fabda76b2a5efd690e5115de75a8943c1b5b127d62914902241490f64c
-  data.tar.gz: 50cd7e761a4cd2bc740ea6ce93e95b268b7b514647c21b06e813f2b50b73e760
+  metadata.gz: af116ffac55aaca5a7cc9cd857d56aa9804c48cdb00f0bf65a687f4fa03cc9b6
+  data.tar.gz: 91fad8c932c7ae1dfbfb270165c82b72e23c0cd289356f6eee3d113e7d626146
 SHA512:
-  metadata.gz: 7141947b51ebae0238cf4b12910154677257b130daa914bd7d764b51559a211f73ad75291c00e097597a6e952891eb17b75acc5065f0d56d0173f232e824ee1a
-  data.tar.gz: a4228f1a3edd66795c2086773010eece50fc531510f44a8aa1d94104a4793f367d04fc137dac34392c8ba93e7af865e8815298241a374d9b137bfd29fe1fdaf1
+  metadata.gz: 327638bbf5b05ff671037a591790212397a1c2620b0c8d5bf7c0c62a04a0d902b519100fa14657b54eb8637031650fa7ee2f3a44c06d81753f3d59d7167a987d
+  data.tar.gz: 4a39fdce0bd44ac7a49e1e90c283205603a8524e7ef83677700d2d042e815e57836e89954b78384e945fb917a03236d1c3f6ca552eb18e2fafa6c07c81888d2f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acts_as_full_calendar_event (1.0.0)
+    acts_as_full_calendar_event (1.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -0,0 +1,83 @@
+# Acts As Full Calendar Event
+Gem to allow any model to work as event for FullCalendar
+
+Acts As Full Calendar Event is a Ruby Gem specifically written for Rails/ActiveRecord models.
+The main goals of this gem are:
+
+- Allow any model to be used as event for [FullCalendar](https://fullcalendar.io/).
+- Provide easy-to-use and reusable methods to perform searchs and filter data.
+- Serialize data for calendar.
+
+## Installation
+
+### Supported Ruby and Rails versions
+
+* Ruby >= 2.3.0
+* Rails >= 4
+
+### Install
+
+Just add the following to your Gemfile to install the latest release.
+
+```ruby
+gem 'acts_as_full_calendar_event', '1.0.1'
+```
+
+And follow that up with a ``bundle install``.
+
+## Usage
+
+```ruby
+class SomeEvent < ActiveRecord::Base
+  acts_as_full_calendar_event field_start: :calendar_inicio,
+    field_end: :calendar_fin,
+    field_title: :calendar_title,
+    field_color: "#FF0000",
+    field_text_color: :calendar_text_color,
+    field_url: :url_for_calendar,
+    field_link_data_toggle: :calendar_link_data_toggle,
+    field_link_data_target: :calendar_link_data_target,
+    method_fields: :for_calendario,
+    method_filter_category: :within_calendar_category,
+    method_filter_user: :by_user_id,
+    method_filter_date: :filter_by_date,
+    method_categories: :categories,
+    field_category_class: :category_class
+end
+```
+
+### Calendar service
+
+Initialize as
+```ruby
+ActsAsFullCalendarEvent::Calendar.new(params: params).filter
+```
+
+params is a hash that must contain:
+· start (Date)
+· end (Date)
+and can also contain:
+· user_id <Integer>
+· Categories <Hash>
+
+Categories hash has the following structure:
+
+`{ "CategoryClassName1" => [id1, id2], "CategoryClassName2" => [id1, id2] }`
+
+If some category class doesn't appear as hash key it will be ignored.
+
+`filter` method returns an `ActiveRecord::Relation` with all matching events
+
+## Testing
+
+All tests follow the RSpec format and are located in the spec directory.
+They can be run with:
+
+```
+rake spec
+```
+
+## License
+
+Acts as votable is released under the [MIT
+License](http://www.opensource.org/licenses/MIT).

data/acts_as_full_calendar_event.gemspec

@@ -5,13 +5,13 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "acts_as_full_calendar_event"
-  s.version     = "1.0.1"
+  s.version     = "1.0.2"
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Adrian Fernandez"]
+  s.author      = ["Adrian Fernandez"]
   s.email       = ["adrianfernandez85@gmail.com"]
   s.homepage    = "http://github.com/adrian-fernandez/acts_as_full_calendar_event"
-  s.summary     = "Rails gem to allowing records to be votable"
-  s.description = "Rails gem to allowing records to be votable"
+  s.summary     = "Rails gem to allowing models to be events for full calendar"
+  s.description = "Rails gem to allowing models to be events for full calendar"
   s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")

data/lib/acts_as_full_calendar_event/services/calendar.rb

@@ -4,9 +4,6 @@ module ActsAsFullCalendarEvent
     private :user_id, :categories, :start_date, :end_date
 
     def initialize(params:)
-      raise(ArgumentError, "params must include 'start' having a date value") if params[:start].blank? || params[:start].class != Date
-      raise(ArgumentError, "params must include 'end' having a date value") if params[:end].blank? || params[:end].class != Date
-
       @user_id = params[:user_id] if params.has_key?(:user_id)
       @categories = JSON.parse(params[:categories] || '{}')
       @start_date = params[:start]

data/spec/services/calendar_spec.rb

@@ -14,24 +14,24 @@ describe ActsAsFullCalendarEvent::Calendar do
       )}.not_to raise_error(ArgumentError)
     end
 
-    it "requires start" do
+    it "doesn't require start" do
       expect { ActsAsFullCalendarEvent::Calendar.new(
         params: {
           user_id: 1,
           end: Date.new(2018, 1, 31),
           categories: { "1": 1 }
         }
-      )}.to raise_error(ArgumentError)
+      )}.not_to raise_error(ArgumentError)
     end
 
-    it "requires end" do
+    it "doesn't require end" do
       expect { ActsAsFullCalendarEvent::Calendar.new(
         params: {
           user_id: 1,
           start: Date.new(2018, 1, 1),
           categories: { "1": 1 }
         }
-      )}.to raise_error(ArgumentError)
+      )}.not_to raise_error(ArgumentError)
     end
 
     it "doesn't require user_id" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_full_calendar_event
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Adrian Fernandez
@@ -150,7 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.3
-description: Rails gem to allowing records to be votable
+description: Rails gem to allowing models to be events for full calendar
 email:
 - adrianfernandez85@gmail.com
 executables: []
@@ -160,6 +160,7 @@ files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - acts_as_full_calendar_event.gemspec
 - lib/acts_as_full_calendar_event.rb
@@ -199,7 +200,7 @@ rubyforge_project:
 rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
-summary: Rails gem to allowing records to be votable
+summary: Rails gem to allowing models to be events for full calendar
 test_files:
 - spec/acts_as_full_calendar_event_spec.rb
 - spec/factories/category.rb