scopy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de96cef11e8765d24e4c521e7db2d8611db53165
+  data.tar.gz: eb9c002ee4993c66ecd377acb1ee57a0ee21aff6
+SHA512:
+  metadata.gz: 55d4ef90a0c7d4f33223d6dddeca0c42c31d70e7d9610415c5b9ad0b8de1168bad5570fd7988609410dff44365c4319d32fbb873a63798dd4844425b11c745b3
+  data.tar.gz: 3487c2e5880668db3de01a17ef1a0d03a7cd8fca03327a1562b32a50055db6df97fc5a7bff01466f0f5637bed818d5ed4243fca49363e36dbd53f41c2cde93a5

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+coverage
+pkg
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scopy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Neighborland, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# Scopy
+
+[![Build Status](https://api.travis-ci.org/neighborland/scopy.png)](https://travis-ci.org/neighborland/scopy)
+
+Scopy provides common ActiveRecord utility scopes as ActiveSupport concerns.
+
+Common scopes for the following attributes are provided:
+
+* `created_at`
+* `id`
+* `name`
+
+## Install
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'scopy'
+```
+
+Scopy works with Rails 3.2 and later.
+
+## Usage
+
+Include the concern modules you would like to use in your models:
+
+```ruby
+class Dog < ActiveRecord::Base
+  include Scopy::CreatedAtScopes
+  include Scopy::IdScopes
+```
+
+The following examples assume you have a model named `Dog`:
+
+##### Scopy::CreatedAtScopes
+
+```ruby
+Dog.newest
+# => most recently created dogs are first
+
+Dog.oldest
+# => most recently created dogs are last
+
+Dog.created_since(1.month.ago)
+# => only dogs created since one month ago
+
+Dog.created_before(1.week.ago)
+# => only dogs created before 1 week ago
+
+Dog.created_between(2.weeks.ago, 1.week.ago)
+# => only dogs created between 2 weeks ago & 1 week ago
+
+Dog.created_on_day(1.day.ago)
+# => dogs created yesterday
+
+Dog.created_in_week(Date.parse("31/10/2013"))
+# => dogs created in the week Sunday-Saturday around October 31, 2013
+
+Dog.created_in_month(Date.parse("1/1/2013"))
+# => dogs created in January 2013
+```
+
+##### Scopy::IdScopes
+
+```ruby
+Dog.excluding_id(123)
+# => dogs excluding id 123
+
+Dog.excluding_ids( [1, 2, 3] )
+# => dogs excluding ids 1, 2, and 3
+
+Dog.excluding(dog)
+# => dogs excluding dog
+```
+
+##### Scopy::NameScopes
+
+```ruby
+Dog.name_like('snoop')
+# => dogs with names containing 'snoop' (case insensitive)
+
+Dog.name_like('snoop', case_sensitive: true)
+# => dogs with names containing 'snoop' (case sensitive)
+
+Dog.name_starts_with('snoop')
+# => dogs with names starting with 'snoop' (case insensitive)
+
+Dog.name_starts_with('snoop', case_sensitive: true)
+# => dogs with names starting with 'snoop' (case sensitive)
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = %w(test/**/*.rb)
+  t.verbose = false
+end

data/lib/scopy.rb

@@ -0,0 +1,5 @@
+require "scopy/version"
+require "scopy/created_at_scopes"
+require "scopy/id_scopes"
+require "scopy/name_scopes"
+

data/lib/scopy/created_at_scopes.rb

@@ -0,0 +1,35 @@
+module Scopy
+  module CreatedAtScopes
+    extend ActiveSupport::Concern
+    
+    included do
+      scope :newest, ->{ order("#{self.table_name}.created_at desc") }
+      scope :oldest, ->{ order("#{self.table_name}.created_at") }
+    
+      scope :created_since, ->(since) do
+        where("#{self.table_name}.created_at > ?", since)
+      end
+
+      scope :created_before, ->(before) do
+        where("#{self.table_name}.created_at < ?", before)
+      end
+
+      scope :created_between, ->(from, to) do
+        created_since(from).created_before(to)
+      end
+
+      scope :created_on_day, ->(date) do
+        created_between date.beginning_of_day, date.end_of_day
+      end
+
+      scope :created_in_week, ->(date, day_of_week=:sunday) do
+        created_between date.beginning_of_week(day_of_week), date.end_of_week(day_of_week)
+      end
+
+      scope :created_in_month, ->(date) do
+        created_between date.beginning_of_month, date.end_of_month
+      end
+    end
+
+  end
+end

data/lib/scopy/id_scopes.rb

@@ -0,0 +1,12 @@
+module Scopy
+  module IdScopes
+    extend ActiveSupport::Concern
+
+    included do
+      scope :excluding_id,  ->(id){ where("#{self.table_name}.id <> ?", id) if id }
+      scope :excluding_ids, ->(ids){ where("#{self.table_name}.id NOT IN (?)", ids) if ids.any? }
+      scope :excluding,     ->(object){ excluding_id(object.id) if object }
+    end
+
+  end
+end

data/lib/scopy/name_scopes.rb

@@ -0,0 +1,34 @@
+module Scopy
+  module NameScopes
+    extend ActiveSupport::Concern
+    
+    # note: case-sensitive like operations do not work as expected in Sqlite,
+    # which we are using as the test database.
+    # see http://stackoverflow.com/questions/973541/how-to-set-sqlite3-to-be-case-insensitive-when-string-comparing
+        
+    included do
+      scope :name_like, ->(text, options={}) do
+        cs = options[:case_sensitive]
+        where("#{_lhs_name_column(cs)} LIKE '%#{_rhs_name_value(text, cs)}%'")
+      end
+      
+      scope :name_starts_with, ->(text, options={}) do
+        cs = options[:case_sensitive]
+        where("#{_lhs_name_column(cs)} LIKE '#{_rhs_name_value(text, cs)}%'")
+      end      
+    end
+    
+  private
+    
+    module ClassMethods          
+      def _lhs_name_column(case_sensitive)
+        case_sensitive ? "#{self.table_name}.name" : "LOWER(#{self.table_name}.name)"
+      end
+      
+      def _rhs_name_value(text, case_sensitive)
+        case_sensitive ? text : text.try(:downcase)
+      end
+    end    
+    
+  end
+end

data/lib/scopy/version.rb

@@ -0,0 +1,3 @@
+module Scopy
+  VERSION = "0.0.1"
+end

data/scopy.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scopy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scopy"
+  spec.version       = Scopy::VERSION
+  spec.authors       = ["Tee Parham"]
+  spec.email         = ["tee@neighborland.com"]
+  spec.description   = %q{Rails ActiveRecord model concerns for common scopes}
+  spec.summary       = %q{Rails ActiveRecord common utility scopes for id, created_at, and name}
+  spec.homepage      = "https://github.com/neighborland/scopy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "test-unit", "~> 2.5"
+  spec.add_development_dependency "mocha", "~> 0.14"
+  spec.add_development_dependency "shoulda-context", "~> 1.1"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+
+  spec.add_runtime_dependency "activerecord", ">= 3.2"
+end

data/test/created_at_scopes_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+class CreatedAtScopesTest < Test::Unit::TestCase
+  class Dog < ActiveRecord::Base
+    include Scopy::CreatedAtScopes
+  end
+  
+  setup do
+    @boo = Dog.create(created_at: 1.week.ago)
+    @snoop = Dog.create(created_at: 1.day.ago)    
+  end  
+      
+  teardown do
+    Dog.delete_all
+  end
+      
+  context ".newest" do
+    should "sort newest first" do
+      assert_equal @snoop, Dog.newest.first
+      assert_equal @boo, Dog.newest.last
+    end    
+  end
+
+  context ".oldest" do
+    should "sort oldest first" do
+      assert_equal @boo, Dog.oldest.first
+      assert_equal @snoop, Dog.oldest.last
+    end    
+  end
+
+  context ".created_since" do
+    should "include since date" do
+      assert Dog.created_since(2.days.ago).include?(@snoop)
+      refute Dog.created_since(2.days.ago).include?(@boo)
+    end    
+  end
+
+  context ".created_before" do
+    should "include before date" do
+      refute Dog.created_before(2.days.ago).include?(@snoop)
+      assert Dog.created_before(2.days.ago).include?(@boo)
+    end    
+  end
+
+  context ".created_between" do
+    should "include between dates" do
+      assert Dog.created_between(2.days.ago, Time.now).include?(@snoop)
+      refute Dog.created_between(2.days.ago, Time.now).include?(@boo)
+    end    
+  end
+
+  context ".created_on_day" do
+    should "include on day" do
+      assert Dog.created_since(2.days.ago).include?(@snoop)
+      refute Dog.created_since(2.days.ago).include?(@boo)
+    end    
+  end
+
+  context ".created_in_week" do
+    should "include in week" do
+      lassie = Dog.create(created_at: 1.month.ago)      
+      assert Dog.created_in_week(1.day.ago).include?(@snoop)
+      refute Dog.created_in_week(1.day.ago).include?(lassie)
+    end    
+  end
+  
+  context ".created_in_month" do
+    should "include in month" do
+      lassie = Dog.create(created_at: 2.months.ago)      
+      assert Dog.created_in_month(1.day.ago).include?(@snoop)
+      refute Dog.created_in_month(1.day.ago).include?(lassie)
+    end    
+  end
+      
+end

data/test/id_scopes_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class IdScopesTest < Test::Unit::TestCase
+  class Dog < ActiveRecord::Base
+    include Scopy::IdScopes
+  end
+  
+  setup do
+    @dog = Dog.create
+  end
+  
+  teardown do
+    Dog.delete_all
+  end
+  
+  context ".excluding_id" do
+    should "exclude" do
+      assert_empty Dog.excluding_id(@dog.id)
+    end
+    
+    should "not exclude" do
+      assert_equal [@dog], Dog.excluding_id(@dog.id + 1)
+    end    
+  end
+
+  context ".excluding_ids" do
+    should "exclude" do
+      assert_empty Dog.excluding_ids([@dog.id])
+    end
+    
+    should "not exclude" do
+      assert_equal [@dog], Dog.excluding_ids([@dog.id + 1])
+    end    
+  end
+
+  context ".excluding" do
+    should "exclude" do
+      assert_empty Dog.excluding(@dog)
+    end
+    
+    should "not exclude" do
+      snoop = Dog.create
+      assert_equal [@dog], Dog.excluding(snoop)
+    end    
+  end
+  
+end

data/test/name_scopes_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class NameScopesTest < Test::Unit::TestCase
+  class Dog < ActiveRecord::Base
+    include Scopy::NameScopes
+  end
+  
+  setup do
+    @dog = Dog.create(name: "Snoop Dogg")
+  end
+  
+  teardown do
+    Dog.delete_all
+  end
+  
+  context ".name_like" do
+    should "find case sensitive" do
+      assert Dog.name_like("Dog", case_sensitive: true).include?(@dog)
+      assert_empty Dog.name_like("cat", case_sensitive: true)
+    end
+    
+    should "find case insensitive" do
+      assert Dog.name_like("doG").include?(@dog)
+      assert_empty Dog.name_like("cat")
+    end
+  end
+  
+  context ".name_starts_with" do
+    should "find case sensitive" do
+      assert Dog.name_starts_with("Snoop", case_sensitive: true).include?(@dog)
+      assert_empty Dog.name_starts_with("Dogg", case_sensitive: true)
+    end
+    
+    should "find case insensitive" do
+      assert Dog.name_starts_with("snOOp").include?(@dog)
+      assert_empty Dog.name_starts_with("dogg")
+    end    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'test/unit'
+require 'shoulda-context'
+require 'mocha/setup'
+require 'active_support'
+require 'active_record'
+require 'sqlite3'
+require 'scopy'
+
+ActiveRecord::Base.logger = Logger.new(STDERR) if ENV["VERBOSE"]
+ 
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+unless ActiveRecord::Base.connection.tables.include? 'dogs'
+  ActiveRecord::Schema.define do  
+    create_table :dogs do |table|
+      table.column :created_at, :datetime
+      table.column :name, :string
+    end
+  end
+end
+ 

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: scopy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tee Parham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Rails ActiveRecord model concerns for common scopes
+email:
+- tee@neighborland.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scopy.rb
+- lib/scopy/created_at_scopes.rb
+- lib/scopy/id_scopes.rb
+- lib/scopy/name_scopes.rb
+- lib/scopy/version.rb
+- scopy.gemspec
+- test/created_at_scopes_test.rb
+- test/id_scopes_test.rb
+- test/name_scopes_test.rb
+- test/test_helper.rb
+homepage: https://github.com/neighborland/scopy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Rails ActiveRecord common utility scopes for id, created_at, and name
+test_files:
+- test/created_at_scopes_test.rb
+- test/id_scopes_test.rb
+- test/name_scopes_test.rb
+- test/test_helper.rb