microscope 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2013, Mirego
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+- Neither the name of the Mirego nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,55 @@
+# Microscope
+
+Microscope adds useful scopes targeting ActiveRecord boolean and datetime fields.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'microscope'
+```
+
+## Usage
+
+```ruby
+create_table "events" do |t|
+  t.string   "name"
+  t.boolean  "special"
+  t.datetime "expired_at"
+end
+
+class Event < ActiveRecord::Base
+  acts_as_microscope
+end
+
+Event.special
+# SELECT * FROM `events` where `events`.`special` = 1
+
+Event.not_special
+# SELECT * FROM `events` where `events`.`special` = 0
+
+Time.now
+# => 2013-07-05 15:43:42
+
+Event.expired_before(2.months.ago)
+# SELECT * FROM `events` where `events`.`expired_at` > '2013-05-05 15:43:42'
+
+Event.expired_before_now
+# SELECT * FROM `events` where `events`.`expired_at` > '2013-07-05 15:43:42'
+
+Event.expired_after_or_at(2.months.from_now)
+# SELECT * FROM `events` where `events`.`expired_at` >= '2013-09-05 15:43:42'
+
+Event.expired_between(2.months.go..1.month.from_now)
+# SELECT * FROM `events` where `events`.`expired_at` BETWEEN '2013-05-05 15:43:42' AND '2013-08-05 15:43:42'
+```
+
+## License
+
+`Microscope` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/microscope/blob/master/LICENSE.md) file.
+
+## About Mirego
+
+Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun.
+We proudly built mobile applications for [iPhone](http://mirego.com/en/iphone-app-development/ "iPhone application development"), [iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"), [Android](http://mirego.com/en/android-app-development/ "Android application development"), [Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"), [Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and [Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development").

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/lib/microscope.rb

@@ -0,0 +1,18 @@
+require "microscope/version"
+
+require 'active_record'
+require 'active_support'
+
+require "microscope/mixin"
+
+module Microscope
+  def self.inject_into_active_record
+    @inject_into_active_record ||= Proc.new do
+      def self.acts_as_microscope
+        self.send :include, Microscope::Mixin
+      end
+    end
+  end
+end
+
+require 'microscope/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/microscope/mixin.rb

@@ -0,0 +1,40 @@
+module Microscope
+  module Mixin
+    extend ActiveSupport::Concern
+
+    included do
+      define_microscrope_scopes
+    end
+
+    module ClassMethods
+      def define_microscrope_scopes
+        model_columns = self.columns.dup
+
+        boolean_fields = model_columns.select { |c| c.type == :boolean }.map(&:name)
+        class_eval do
+          boolean_fields.each do |field|
+            scope field, where(field => true)
+            scope "not_#{field}", where(field => false)
+          end
+        end
+
+        datetime_fields = model_columns.select { |c| c.type == :datetime }.map(&:name)
+        class_eval do
+          datetime_fields.each do |field|
+            cropped_field = field.gsub(/_at$/, '')
+
+            scope "#{cropped_field}_before", lambda { |time| where(["#{field} < ?", time]) }
+            scope "#{cropped_field}_before_or_at", lambda { |time| where(["#{field} <= ?", time]) }
+            scope "#{cropped_field}_before_now", lambda { where(["#{field} < ?", Time.now]) }
+
+            scope "#{cropped_field}_after", lambda { |time| where(["#{field} > ?", time]) }
+            scope "#{cropped_field}_after_or_at", lambda { |time| where(["#{field} >= ?", time]) }
+            scope "#{cropped_field}_after_now", lambda { where(["#{field} > ?", Time.now]) }
+
+            scope "#{cropped_field}_between", lambda { |range| where(field => range) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/microscope/railtie.rb

@@ -0,0 +1,10 @@
+require 'microscope'
+require 'rails'
+
+module Microscope
+  class Railtie < Rails::Railtie
+    initializer 'microscope.active_record' do |app|
+      ActiveSupport.on_load :active_record, {}, &Microscope.inject_into_active_record
+    end
+  end
+end

data/lib/microscope/version.rb

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

data/microscope.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'microscope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'microscope'
+  spec.version       = Microscope::VERSION
+  spec.authors       = ["Simon Prévost", "Rémi Prévost"]
+  spec.email         = ["sprevost@mirego.com", "rprevost@mirego.com"]
+  spec.description   = 'Microscope adds useful scopes targeting ActiveRecord boolean and datetime fields.'
+  spec.summary       = 'Microscope adds useful scopes targeting ActiveRecord boolean and datetime fields.'
+  spec.homepage      = 'https://github.com/mirego/microscope'
+  spec.license       = 'BSD 3-Clause'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '>= 3.0.0'
+  spec.add_dependency 'activerecord', '>= 3.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+end

data/spec/microscope/mixin_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Microscope::Mixin do
+  describe 'Boolean scopes' do
+    subject { User }
+
+    before do
+      run_migration do
+        create_table(:users, force: true) do |t|
+          t.boolean :active, default: false
+        end
+      end
+
+      microscope 'User'
+    end
+
+    describe 'positive scope' do
+      before { @user1 = User.create(active: true) }
+
+      its(:active) { should have(1).items }
+      its(:active) { should include(@user1) }
+      its(:not_active) { should be_empty }
+    end
+
+    describe 'negative scope' do
+      before { @user1 = User.create(active: false) }
+
+      its(:not_active) { should have(1).items }
+      its(:not_active) { should include(@user1) }
+      its(:active) { should be_empty }
+    end
+  end
+
+  describe 'DateTime scopes' do
+    subject { Event }
+
+    before do
+      run_migration do
+        create_table(:events, force: true) do |t|
+          t.datetime :started_at, default: false
+        end
+      end
+
+      microscope 'Event'
+    end
+
+    describe 'before scope' do
+      before do
+        @event = Event.create(started_at: 2.months.ago)
+        Event.create(started_at: 1.month.from_now)
+      end
+
+      it { expect(Event.started_before(1.month.ago).to_a).to eql [@event] }
+    end
+
+    describe 'before_now scope' do
+      before do
+        @event = Event.create(started_at: 2.months.ago)
+        Event.create(started_at: 1.month.from_now)
+      end
+
+      it { expect(Event.started_before_now.to_a).to eql [@event] }
+    end
+
+    describe 'after scope' do
+      before do
+        @event = Event.create(started_at: 2.months.from_now)
+        Event.create(started_at: 1.month.ago)
+      end
+
+      it { expect(Event.started_after(1.month.from_now).to_a).to eql [@event] }
+    end
+
+    describe 'after_now scope' do
+      before do
+        @event = Event.create(started_at: 2.months.from_now)
+        Event.create(started_at: 1.month.ago)
+      end
+
+      it { expect(Event.started_after_now.to_a).to eql [@event] }
+    end
+
+    describe 'between scope' do
+      before do
+        Event.create(started_at: 1.month.ago)
+        @event = Event.create(started_at: 3.months.ago)
+        Event.create(started_at: 5.month.ago)
+      end
+
+      it { expect(Event.started_between(4.months.ago..2.months.ago).to_a).to eql [@event] }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rspec'
+require 'sqlite3'
+
+require 'microscope'
+
+# Require our macros and extensions
+Dir[File.expand_path('../../spec/support/macros/*.rb', __FILE__)].map(&method(:require))
+
+# Inject our methods into ActiveRecord (like our railtie does)
+ActiveRecord::Base.class_eval(&Microscope.inject_into_active_record)
+
+RSpec.configure do |config|
+  # Include our macros
+  config.include DatabaseMacros
+  config.include ModelMacros
+
+  config.before(:each) do
+    # Create the SQLite database
+    setup_database
+  end
+
+  config.after(:each) do
+    # Make sure we remove our test database file
+    cleanup_database
+  end
+end

data/spec/support/macros/database_macros.rb

@@ -0,0 +1,33 @@
+module DatabaseMacros
+  # Run migrations in the test database
+  def run_migration(&block)
+    # Create a new migration class
+    klass = Class.new(ActiveRecord::Migration)
+
+    # Create a new `up` that executes the argument
+    klass.send(:define_method, :up) { self.instance_exec(&block) }
+
+    # Create a new instance of it and execute its `up` method
+    klass.new.up
+  end
+
+  def self.database_file
+    @database_file || File.expand_path('../test.db', __FILE__)
+  end
+
+  def setup_database
+    # Make sure the test database file is gone
+    cleanup_database
+
+    # Establish the connection
+    SQLite3::Database.new FileUtils.touch(DatabaseMacros.database_file).first
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: DatabaseMacros.database_file)
+
+    # Silence everything
+    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = false
+  end
+
+  def cleanup_database
+    FileUtils.rm(DatabaseMacros.database_file) if File.exists?(DatabaseMacros.database_file)
+  end
+end

data/spec/support/macros/model_macros.rb

@@ -0,0 +1,18 @@
+module ModelMacros
+  # Create a new microscope model
+  def microscope(klass_name, &block)
+    spawn_model klass_name, ActiveRecord::Base do
+      acts_as_microscope
+      instance_exec(&block) if block
+    end
+  end
+
+  protected
+
+  # Create a new model class
+  def spawn_model(klass_name, parent_klass, &block)
+    Object.instance_eval { remove_const klass_name } if Object.const_defined?(klass_name)
+    Object.const_set(klass_name, Class.new(parent_klass))
+    Object.const_get(klass_name).class_eval(&block) if block_given?
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: microscope
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Simon Prévost
+- Rémi Prévost
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Microscope adds useful scopes targeting ActiveRecord boolean and datetime
+  fields.
+email:
+- sprevost@mirego.com
+- rprevost@mirego.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/microscope.rb
+- lib/microscope/mixin.rb
+- lib/microscope/railtie.rb
+- lib/microscope/version.rb
+- microscope.gemspec
+- spec/microscope/mixin_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb
+homepage: https://github.com/mirego/microscope
+licenses:
+- BSD 3-Clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 533199632649490219
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 533199632649490219
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Microscope adds useful scopes targeting ActiveRecord boolean and datetime
+  fields.
+test_files:
+- spec/microscope/mixin_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb