season 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79b28b9578876f09d5400f07f274fa4b09403f73
-  data.tar.gz: f92588ed36959b02592fdd52a654aa77651da231
+  metadata.gz: 899d9f7e0405d00eb51394bcb984c496ed0b06fc
+  data.tar.gz: 91138329eec2efd1ee082eb6e30dc284a418047f
 SHA512:
-  metadata.gz: 97af23dc94be0015526dfee136ce23b3d14e163472091116efc9240560369ecf635b12150ecced3448a8bb60a4447f7e3312cbc5253a01c0f09b9b868ab53fdb
-  data.tar.gz: dae5f32b172de1dff47a1d0a9c397039c7cec56d5842f7a97fa1af95c5188ea1fe8456c8c096e2e90c9ac5fc2f3f1f95628207b4344490f5f642a107e028a9e8
+  metadata.gz: af150a59bfa9de34841468175840cd0edfa130c38232dcd934fa04a6321ccc28550d45ca0c680323e3a55b3cc4b062bf8d22d15c8fa703caeaa77861ca2d1fdf
+  data.tar.gz: 6d83a87905bf1941d0108d245f26e9a17c1a9d9c2fa512ed12b4e45fb0862ebef1c389201d71584c3e5927718331c50974d0d047fdbb0af6a4db389d14e0286a

data/README.md

@@ -1,14 +1,15 @@
 # Season
 [![Gem Version](https://badge.fury.io/rb/season.svg)](http://badge.fury.io/rb/season) [![Code Climate](https://codeclimate.com/github/joaodiogocosta/season/badges/gpa.svg)](https://codeclimate.com/github/joaodiogocosta/season) [![Build Status](https://travis-ci.org/joaodiogocosta/season.svg?branch=master)](https://travis-ci.org/joaodiogocosta/season)
 
-Season let's you easily query your Models by a specific date/time.
+Season automatically creates scopes for your models' datetime columns.
+How many times have you done ugly things like `where("users.created_at" > ?", some_date)`? If you ever built a REST API with endpoints that return a list of records, I'm sure you've done plenty of this. And that's why Season exists.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'season', '~> 0.1'
+gem 'season', '~> 0.2'
 ```
 
 And then execute:
@@ -25,28 +26,31 @@ In this first version Season only supports ActiveRecord, but we plan to also sup
 
 ## Usage
 
-Season assumes your models have timestamps columns (created_at and updated_at) and uses these to do its magic.
-
-Right now, Season gives you the following helper methods:
+To use Season scopes just append `_before`, `_after` or `_between` to your datetime column names and pass the arguments accordingly. See this:
 
+First, include Season in your model(s):
 ```ruby
-# Include it in your models
-
 class User < ActiveRecord::Base
-  include Season::Scopes
+  include Season
   ...
 end
+```
+
+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.
 
-# And then use it as:
-# (Time/DateTime/String instances are allowed as arguments)
+User.created_at_before(Time.now)
+User.created_at_after(DateTime.now)
+User.created_at_between(Time.now - 1.week, '31-01-2015')
 
-User.created_before(Time.now)
-User.created_after(DateTime.now)
-User.created_between(Time.now - 1.week, '31-01-2015')
+User.updated_at_before(DateTime.now)
+User.updated_at_after('01-01-2015')
+User.updated_at_between(Time.now - 1.week, Time.now)
 
-User.updated_before(DateTime.now)
-User.updated_after('01-01-2015')
-User.updated_between(Time.now - 1.week, Time.now)
+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)
 ```
 
 They are chainable, so you can also do things like this:
@@ -55,33 +59,13 @@ User.where(id: [1, 2, 3]).created_before(Time.now)
 User.updated_after('01-01-2015').order(created_at: :asc)
 ```
 
-
-## 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
 
 - 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')`)
-- Support user-defined date/time columns (through configuration)
+- Add support for queries with joins
 
 ## Contributing
 

data/lib/season.rb

@@ -1,3 +1,32 @@
 require "season/version"
 require "season/configuration"
-require "season/active_record/scopes" if defined? ActiveRecord
+require "season/legacy"
+require "season/scope_builder"
+require "season/query_builder"
+
+module Season
+
+  QUERY_VERBS = ['before', 'after', 'between']
+
+  def self.included(base)
+    base.extend(ClassMethods)
+
+    mb = ScopeBuilder.new(base)
+
+    base.class_eval do
+      # DEFINE SCOPES DINAMICALLY
+      base.datetime_column_names.each do |column_name|
+        QUERY_VERBS.each do |query_verb|
+          mb.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
+    end
+  end
+end
+

data/lib/season/configuration.rb

@@ -23,7 +23,8 @@ module Season
 
     def self.auto_include_scopes
       if configuration.include_by_default
-        ActiveRecord::Base.send(:include, Season::Scopes) if defined? ActiveRecord
+        warn "[DEPRECATED] Include season scopes by default is deprecated and will be removed before v0.5 - See https://github.com/joaodiogocosta/season for more"
+        ActiveRecord::Base.send(:include, Season::Legacy) if defined? ActiveRecord
       end
     end
 end

data/lib/season/{active_record/scopes.rb → legacy.rb}

@@ -1,6 +1,5 @@
 module Season
-  module Scopes
-
+  module Legacy
     def self.included(base)
       base.class_eval do
         def self.created_before(date)
@@ -29,4 +28,4 @@ module Season
       end
     end
   end
-end
+end

data/lib/season/query_builder.rb

@@ -0,0 +1,26 @@
+module Season
+  class QueryBuilder
+
+    def initialize(adapter_class_name)
+      @adapter_class_name = adapter_class_name
+    end
+
+    def build(table_name, column_name, query_verb)
+      self.send("#{@adapter_class_name}_#{query_verb}", table_name, column_name)
+    end
+
+    private
+
+      def active_record_before(table_name, column_name)
+        "where(" + "\"#{table_name}.#{column_name} < ?\"" + ", *args)"
+      end
+
+      def active_record_between(table_name, column_name)
+        "where(" + "\"#{table_name}.#{column_name} > ? AND #{table_name}.#{column_name} < ?\"" + ", *args)"
+      end
+
+      def active_record_after(table_name, column_name)
+        "where(" + "\"#{table_name}.#{column_name} > ?\"" + ", *args)"
+      end
+  end
+end

data/lib/season/scope_builder.rb

@@ -0,0 +1,34 @@
+module Season
+  class ScopeBuilder
+
+    def initialize(klass)
+      @klass = klass
+      @query_builder = QueryBuilder.new(adapter_class_name)
+    end
+
+    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
+      end
+    end
+
+    private
+
+      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 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.1"
+  VERSION = "0.2"
 end

data/season.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Season::VERSION
   spec.authors       = ["Joao Diogo Costa"]
   spec.email         = ["jdscosta91@gmail.com"]
-  spec.summary       = %q{Season lets you query your ActiveRecord models by a specified period of time in an easier way.}
-  spec.description   = %q{Season lets you query your ActiveRecord models by a specified period of time in an easier way.}
+  spec.summary       = %q{Season automatically creates scopes for your models' datetime columns.}
+  spec.description   = %q{Season automatically creates scopes for your models' datetime columns.}
   spec.homepage      = "https://github.com/joaodiogocosta/season"
   spec.license       = "MIT"
 

data/spec/scopes_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'active_record'
+
+silence_warnings do
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Base.logger = Logger.new(nil)
+  ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3', database: ':memory:')
+end
+
+ActiveRecord::Base.connection.instance_eval do
+  create_table :users do |t|
+    t.datetime :created_at
+    t.datetime :updated_at
+    t.timestamp :confirmed_at
+  end
+end
+
+Season.configure do |config|
+  config.include_by_default = true
+end
+
+class User < ActiveRecord::Base
+  include Season
+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
+  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
+  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
+  end
+
+  it 'has legacy scopes' do
+    expect(subject.created_at_before(Time.now)).to eq([])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: season
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Joao Diogo Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-07 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,8 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: Season lets you query your ActiveRecord models by a specified period
-  of time in an easier way.
+description: Season automatically creates scopes for your models' datetime columns.
 email:
 - jdscosta91@gmail.com
 executables: []
@@ -125,11 +124,13 @@ files:
 - README.md
 - Rakefile
 - lib/season.rb
-- lib/season/active_record/scopes.rb
 - lib/season/configuration.rb
+- lib/season/legacy.rb
+- lib/season/query_builder.rb
+- lib/season/scope_builder.rb
 - lib/season/version.rb
 - season.gemspec
-- spec/active_record/scopes_spec.rb
+- spec/scopes_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/joaodiogocosta/season
 licenses:
@@ -154,8 +155,7 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: Season lets you query your ActiveRecord models by a specified period of time
-  in an easier way.
+summary: Season automatically creates scopes for your models' datetime columns.
 test_files:
-- spec/active_record/scopes_spec.rb
+- spec/scopes_spec.rb
 - spec/spec_helper.rb

data/spec/active_record/scopes_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-require 'active_record'
-require 'season/active_record/scopes'
-
-silence_warnings do
-  ActiveRecord::Migration.verbose = false
-  ActiveRecord::Base.logger = Logger.new(nil)
-  ActiveRecord::Base.establish_connection(
-    adapter: 'sqlite3', database: ':memory:')
-end
-
-ActiveRecord::Base.connection.instance_eval do
-  create_table :users do |t|
-    t.timestamps null: true
-  end
-end
-
-class User < ActiveRecord::Base
-  include Season::Scopes
-end
-
-RSpec.describe Season::Scopes do
-  subject { User }
-
-  describe 'class methods' do
-    describe 'with default timestamps' do
-      it 'responds to created_(before/after/between)' do
-        expect(subject).to respond_to(:created_before, :created_after)
-          .with(1).argument
-        expect(subject).to respond_to(:created_between).with(2).arguments
-      end
-
-      it 'responds to updated_(before/after/between)' do
-        expect(subject).to respond_to(:updated_before, :updated_after)
-          .with(1).argument
-        expect(subject).to respond_to(:updated_between).with(2).arguments
-      end
-    end
-  end
-end