season 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 899d9f7e0405d00eb51394bcb984c496ed0b06fc
-  data.tar.gz: 91138329eec2efd1ee082eb6e30dc284a418047f
+  metadata.gz: ee585a77f75b912e9967cee60051590a4df64ddb
+  data.tar.gz: db1c30b2d54d0bec8f2e36c0b10cfa6b657150b6
 SHA512:
-  metadata.gz: af150a59bfa9de34841468175840cd0edfa130c38232dcd934fa04a6321ccc28550d45ca0c680323e3a55b3cc4b062bf8d22d15c8fa703caeaa77861ca2d1fdf
-  data.tar.gz: 6d83a87905bf1941d0108d245f26e9a17c1a9d9c2fa512ed12b4e45fb0862ebef1c389201d71584c3e5927718331c50974d0d047fdbb0af6a4db389d14e0286a
+  metadata.gz: 6f2d10ab32b50dbf017b57ba7ffbf31bcd38186aadd43ec23faa49f32b90279531c648caa9fc21d6e0cc0ac057d1f0faa5c936507f8e24427e3be9d6ca876a8e
+  data.tar.gz: 874d00169c9fc23a75f37c57ec75e08aca1b3ffd9881dd6950b9891e65d1f7597246162fca0f948fe16913d998810adbb82c184ed1c8d07d2251a7e0b449a469

data/.gitignore

@@ -12,3 +12,5 @@
 *.o
 *.a
 mkmf.log
+*.sublime-project
+*.sublime-workspace

data/README.md

@@ -26,7 +26,7 @@ In this first version Season only supports ActiveRecord, but we plan to also sup
 
 ## Usage
 
-To use Season scopes just append `_before`, `_after` or `_between` to your datetime column names and pass the arguments accordingly. See this:
+To use Season scopes just append `_before`, `_after` or `_between` to your date/datetime/timestamp column names and pass the arguments accordingly. See this:
 
 First, include Season in your model(s):
 ```ruby
@@ -36,6 +36,8 @@ class User < ActiveRecord::Base
 end
 ```
 
+### Scopes
+
 Now, considering that our `User` class has three datetime columns named `:created_at`, `:updated_at` and `:confirmed_at`, the following scopes will be automatically available: 
 ```ruby
 # * Time/DateTime/String instances are allowed as arguments.
@@ -43,14 +45,17 @@ Now, considering that our `User` class has three datetime columns named `:create
 User.created_at_before(Time.now)
 User.created_at_after(DateTime.now)
 User.created_at_between(Time.now - 1.week, '31-01-2015')
+# => [ActiveRecord::Relation of Users]
 
 User.updated_at_before(DateTime.now)
 User.updated_at_after('01-01-2015')
 User.updated_at_between(Time.now - 1.week, Time.now)
+# => [ActiveRecord::Relation of Users]
 
 User.confirmed_at_before('01-01-2015')
 User.confirmed_at_after(DateTime.now)
 User.confirmed_at_between(Time.now - 1.year, Time.now - 1.week)
+# => [ActiveRecord::Relation of Users]
 ```
 
 They are chainable, so you can also do things like this:
@@ -59,13 +64,21 @@ User.where(id: [1, 2, 3]).created_before(Time.now)
 User.updated_after('01-01-2015').order(created_at: :asc)
 ```
 
+### Instance methods
+
+Other than scopes, useful instance methos will also be available:
+```ruby
+joe = User.first
+
+joe.created_at_before?(Time.now)
+joe.updated_at_after?('10-10-2000')
+joe.confirmed_at_between?('20-10-2013', DateTime.now)
+# => true or false
+```
+
 ## To Do
 
-- Even more tests
-- Support other ORMs (Mongoid, 'insert-more-here')
-- Add Error Handling
-- Add helpers for instances (like `User.first.created_before?('01-02-2015')`)
-- Add support for queries with joins
+- Support other ORMs (Mongoid, ...?)
 
 ## Contributing
 

data/lib/season.rb

@@ -3,6 +3,7 @@ require "season/configuration"
 require "season/legacy"
 require "season/scope_builder"
 require "season/query_builder"
+require "season/instance_method_builder"
 
 module Season
 
@@ -11,22 +12,35 @@ module Season
   def self.included(base)
     base.extend(ClassMethods)
 
-    mb = ScopeBuilder.new(base)
+    # Define scopes
+    sb = ScopeBuilder.new(base)
+    base.class_eval do
+      base.date_or_time_column_names.each do |column_name|
+        QUERY_VERBS.each do |query_verb|
+          sb.build(table_name, column_name, query_verb)
+        end
+      end
+    end
 
+    # Define instance methods
+    imb = InstanceMethodBuilder.new(base)
     base.class_eval do
-      # DEFINE SCOPES DINAMICALLY
-      base.datetime_column_names.each do |column_name|
+      base.date_or_time_column_names.each do |column_name|
         QUERY_VERBS.each do |query_verb|
-          mb.build(table_name, column_name, query_verb)
+          imb.build(table_name, column_name, query_verb)
         end
       end
     end
   end
 
   module ClassMethods
-    def datetime_column_names
-      columns.map { |c| c.name if c.type == :datetime }.compact
+    def date_or_time_column_names
+      columns.map { |c| c.name if c.type == :datetime || c.type == :date }.compact
     end
   end
+
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
 end
 

data/lib/season/instance_method_builder.rb

@@ -0,0 +1,45 @@
+module Season
+  class InstanceMethodBuilder
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def build(table_name, column_name, query_verb)
+      method_val = self.send(query_verb, column_name)
+
+      @klass.class_eval %Q{
+        def #{column_name}_#{query_verb}?(*args)
+          #{method_val}
+        end
+      }
+    end
+
+    private
+
+      def parse_input(date_input)
+        date_input= case date_input.class
+                    when Time || Date || ActiveSupport::TimeWithZone
+                      date_input.to_i
+                    when DateTime
+                      date_input
+                    when String
+                      DateTime.parse(date_input)
+                    else
+                      raise ArgumentError, 'Invalid date_to_compare to compare.'
+                    end
+      end
+
+      def before(column_name)
+        "#{column_name} < args.first"
+      end
+
+      def after(column_name)
+        "#{column_name} > args.first"
+      end
+
+      def between(column_name)
+        "#{column_name} > args.first || #{column_name} < args.last"
+      end
+  end  
+end

data/lib/season/legacy.rb

@@ -28,4 +28,5 @@ module Season
       end
     end
   end
-end
+end
+

data/lib/season/scope_builder.rb

@@ -9,26 +9,28 @@ module Season
     def build(table_name, column_name, query_verb)
       unless method_exists?(column_name)
         query_str = @query_builder.build(table_name, column_name, query_verb)
-        
-        @klass.define_singleton_method "#{column_name}_#{query_verb}" do |*args|
-          eval(query_str)
-        end
+
+        @klass.instance_eval %Q{
+          def #{column_name}_#{query_verb}(*args)
+            #{query_str}
+          end
+        }
       end
     end
 
     private
 
-      def method_exists?(column_name)
-        defined? @klass.column_name
-      end
+    def method_exists?(column_name)
+      defined? @klass.column_name
+    end
 
-      def adapter_class_name
-        return 'active_record' if @klass < ActiveRecord::Base
-        raise "Database adapter not supported."
-      end
+    def adapter_class_name
+      return 'active_record' if @klass < ActiveRecord::Base
+      raise "Database adapter not supported."
+    end
 
-      # def remove_old_suffix(text)
-      #   text.sub(/(#{POPULAR_SUFFIXES.join('|')})$/, '') || text
-      # end
-  end  
+    # def remove_old_suffix(text)
+    #   text.sub(/(#{POPULAR_SUFFIXES.join('|')})$/, '') || text
+    # end
+  end
 end

data/lib/season/version.rb

@@ -1,3 +1,3 @@
 module Season
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/season.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "activerecord", "~> 4.0"
   spec.add_development_dependency "rubocop", "~> 0.29"
   spec.add_development_dependency "rubocop-rspec", "~> 1.2"
-  spec.add_development_dependency "sqlite3", "~> 1.3" 
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "database_cleaner", "~> 1.4" 
 end

data/spec/scopes_spec.rb

@@ -12,6 +12,7 @@ ActiveRecord::Base.connection.instance_eval do
   create_table :users do |t|
     t.datetime :created_at
     t.datetime :updated_at
+    t.date :birthdate
     t.timestamp :confirmed_at
   end
 end
@@ -27,28 +28,95 @@ end
 RSpec.describe Season do
   subject { User }
 
-  it 'has scopes to datetime columns of datetime type' do
-    expect(subject).to respond_to(:created_at_before, :created_at_after)
-      .with(1).argument
-    expect(subject).to respond_to(:created_at_between).with(2).arguments
+  describe 'defined datetime scopes' do
+    it 'of datetime type' do
+      expect(subject).to respond_to(:created_at_before, :created_at_after)
+        .with(1).argument
+      expect(subject).to respond_to(:created_at_between).with(2).arguments
+    end
+
+    it 'of date type' do
+      expect(subject).to respond_to(:birthdate_before, :birthdate_after)
+        .with(1).argument
+      expect(subject).to respond_to(:birthdate_between).with(2).arguments
+    end
+
+    it 'of timestamp type' do
+      expect(subject).to respond_to(:confirmed_at_before, :confirmed_at_after)
+        .with(1).argument
+      expect(subject).to respond_to(:confirmed_at_between).with(2).arguments
+    end
+
+    it ' - legacy' do
+      expect(subject).to respond_to(:created_before, :created_after)
+        .with(1).argument
+      expect(subject).to respond_to(:created_between).with(2).arguments
+      expect(subject).to respond_to(:updated_before, :updated_after)
+        .with(1).argument
+      expect(subject).to respond_to(:updated_between).with(2).arguments
+    end
   end
 
-  it 'has scopes to datetime columns of timestamp type' do
-    expect(subject).to respond_to(:confirmed_at_before, :confirmed_at_after)
-      .with(1).argument
-    expect(subject).to respond_to(:confirmed_at_between).with(2).arguments
+  describe 'datetime scopes' do
+
+    let(:instant) { DateTime.parse('01-01-2015') }
+
+    before do
+      User.create!(created_at: instant - 1.year)
+      User.create!(created_at: instant + 1.year)
+    end
+
+    it "shows correct results for 'before'" do
+      expect(subject.created_at_before(instant).count).to eq(1)
+    end
+
+    it "shows correct results for 'after'" do
+      expect(subject.created_at_after(instant).count).to eq(1)
+    end
+
+    it "shows correct results for 'between'" do
+      expect(subject.created_at_between(instant - 2.year, instant + 2.year).count).to eq(2)
+    end
   end
 
-  it 'has legacy scopes' do
-    expect(subject).to respond_to(:created_before, :created_after)
-      .with(1).argument
-    expect(subject).to respond_to(:created_between).with(2).arguments
-    expect(subject).to respond_to(:updated_before, :updated_after)
-      .with(1).argument
-    expect(subject).to respond_to(:updated_between).with(2).arguments
+  describe 'defined datetime instance methods' do
+
+    let(:user) { User.new }
+
+    it 'of datetime type' do
+      expect(user).to respond_to(:created_at_before?, :created_at_after?)
+        .with(1).argument
+      expect(user).to respond_to(:created_at_between?).with(2).arguments
+    end
+
+    it 'of date type' do
+      expect(user).to respond_to(:birthdate_before?, :birthdate_after?)
+        .with(1).argument
+      expect(user).to respond_to(:birthdate_between?).with(2).arguments
+    end
+
+    it 'of timestamp type' do
+      expect(user).to respond_to(:confirmed_at_before?, :confirmed_at_after?)
+        .with(1).argument
+      expect(user).to respond_to(:confirmed_at_between?).with(2).arguments
+    end
   end
 
-  it 'has legacy scopes' do
-    expect(subject.created_at_before(Time.now)).to eq([])
+  describe 'datetime instance methods' do
+
+    let(:instant) { DateTime.parse('01-01-2015') }
+    let(:user) { User.create!(created_at: instant) }
+
+    it "shows correct results for 'before'" do
+      expect(user.created_at_before?(instant + 1.day)).to eq(true)
+    end
+
+    it "shows correct results for 'after'" do
+      expect(user.created_at_after?(instant - 1.day)).to eq(true)
+    end
+
+    it "shows correct results for 'between'" do
+      expect(user.created_at_between?(instant - 1.day, instant + 1.day)).to eq(true)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'season'
+require 'database_cleaner'
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
 
@@ -10,4 +11,17 @@ RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: season
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Joao Diogo Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: Season automatically creates scopes for your models' datetime columns.
 email:
 - jdscosta91@gmail.com
@@ -125,6 +139,7 @@ files:
 - Rakefile
 - lib/season.rb
 - lib/season/configuration.rb
+- lib/season/instance_method_builder.rb
 - lib/season/legacy.rb
 - lib/season/query_builder.rb
 - lib/season/scope_builder.rb