season 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14ba902afe4fe1b37986e39469d170fb7d8222db
-  data.tar.gz: 6deb23cd6ec76f510fc30e3478e249e06b0bedff
+  metadata.gz: 8e0c66e1e302ebb2e68c7789ee0b49731b08f0a2
+  data.tar.gz: b2f79c55e993bbd294d86deadbcad0e77d009979
 SHA512:
-  metadata.gz: 19937a336bd5df579cce48b946f2071c6347ef1d03876b01b50b12dcc9956c3af8b2d2eca00a7d8ebf7795ced5f94e1f6713a9f42c39515905a9908931e9b84a
-  data.tar.gz: 1cdc28b8dfd71fad4933d0507d691823b1f1d461c918d4f8960068d3d04ee6c7b0ccb86f7cfa52650900dca3e99733072c60ec6d28064bbb89d5758973a64919
+  metadata.gz: 736c259aaeeab9042a84d37e2269f20bcef9febd48fb07a6cfc0ab5da821fffda3a654fe41212e82a079536c7046b4c7e4039016dca1f92f94ec57450853526e
+  data.tar.gz: 701160c347723fb7db232ddb565c6af9bdedd8bdc13c9c9055296c4da97a6739d9da0e62348cf4e668d7aaee058d11a1330ee924e66db02503a2392f74c47c8c

data/README.md

@@ -31,26 +31,49 @@ Right now, Season gives you the following helper methods:
 ```ruby
 # You can pass instances of Time/DateTime/String as arguments
 
-MyModel.created_before(Time.now)
-MyModel.created_after(DateTime.now)
-MyModel.created_between(Time.now - 1.week, '31-01-2015')
+class User < ActiveRecord::Base; end
 
-MyModel.updated_before(DateTime.now)
-MyModel.updated_after('01-01-2015')
-MyModel.updated_between(Time.now - 1.week, Time.now)
+User.created_before(Time.now)
+User.created_after(DateTime.now)
+User.created_between(Time.now - 1.week, '31-01-2015')
+
+User.updated_before(DateTime.now)
+User.updated_after('01-01-2015')
+User.updated_between(Time.now - 1.week, Time.now)
+```
+
+## Configuration
+
+The scopes are not included by default in your models. To use them you need to include it yourself:
+
+```ruby
+Class User < ActiveRecord::Base
+  include Season::Scopes
+
+  ...
+
+end 
+```
+
+If you want them to be available on all of your models by default, add the following code within an initializer - `config/initializers/season.rb`:
+
+```ruby
+Season.configure do |config|
+  config.include_by_default = true
+end 
 ``` 
 
 ## To Do
 
 - Tests!
-- Support other ORMs (Mongoid, <insert-more-here>)
+- Support other ORMs (Mongoid, 'insert-more-here')
 - Add Error Handling
 - Support user-defined date/time columns (through configuration)
 - Support configuration for enabling/disabling Season for all models
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/season/fork )
+1. Fork it ( https://github.com/joaodiogocosta/season/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/season/active_record/scopes.rb

@@ -1,34 +1,33 @@
-module Scopes
+module Season
+  module Scopes
 
-  def self.included(base)
-    base.class_eval do
-      def self.created_before(date)
-        where("#{table_name}.created_at < ?", date)
-      end
+    def self.included(base)
+      base.class_eval do
+        def self.created_before(date)
+          where("#{table_name}.created_at < ?", date)
+        end
 
-      def self.created_between(start_date, end_date)
-        where("#{table_name}.created_at > ? AND #{table_name}.created_at < ?", start_date, end_date)
-      end
+        def self.created_between(start_date, end_date)
+          where("#{table_name}.created_at > ? AND #{table_name}.created_at < ?", start_date, end_date)
+        end
 
-      def self.created_after(date)
-        where("#{table_name}.created_at > ?", date)
-      end
+        def self.created_after(date)
+          where("#{table_name}.created_at > ?", date)
+        end
 
 
-      def self.updated_before(date)
-        where("#{table_name}.updated_at < ?", date)
-      end
+        def self.updated_before(date)
+          where("#{table_name}.updated_at < ?", date)
+        end
 
-      def self.updated_between(start_date, end_date)
-        where("#{table_name}.updated_at > ? AND #{table_name}.updated_at < ?", start_date, end_date)
-      end
+        def self.updated_between(start_date, end_date)
+          where("#{table_name}.updated_at > ? AND #{table_name}.updated_at < ?", start_date, end_date)
+        end
 
-      def self.updated_after(date)
-        where("#{table_name}.updated_at > ?", date)
+        def self.updated_after(date)
+          where("#{table_name}.updated_at > ?", date)
+        end
       end
     end
   end
-  
 end
-
-ActiveRecord::Base.send(:include, Scopes)

data/lib/season/configuration.rb

@@ -0,0 +1,29 @@
+module Season
+
+  class Configuration
+
+    attr_accessor :include_by_default
+
+    def initialize
+      @include_by_default = false
+    end
+
+  end
+    
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+    auto_include_scopes
+  end
+
+  private
+
+    def self.auto_include_scopes
+      if configuration.include_by_default
+        ActiveRecord::Base.send(:include, Season::Scopes) if defined? ActiveRecord
+      end
+    end
+end

data/lib/season/version.rb

@@ -1,3 +1,3 @@
 module Season
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/season.rb

@@ -1,6 +1,3 @@
 require "season/version"
+require "season/configuration"
 require "season/active_record/scopes" if defined? ActiveRecord
-
-module Season
-
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: season
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joao Diogo Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,7 @@ files:
 - Rakefile
 - lib/season.rb
 - lib/season/active_record/scopes.rb
+- lib/season/configuration.rb
 - lib/season/version.rb
 - season.gemspec
 - spec/scopes.rb