microscope 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dae239d9a336e0f5dae1eb39800dbf21eecef2d5
-  data.tar.gz: 2afd2fc1a3eaa7dddb9282a1f1a8daee169a8ec9
+SHA256:
+  metadata.gz: d82e5b5ee4fb4f9bedcebb024def72fcab59cdc01804600ffbd2a750e01c711b
+  data.tar.gz: 74cc590cf95eeadcd537b3dfbaf4edac1d76f3a23007a3bca48d812f169f90d7
 SHA512:
-  metadata.gz: 9348ae5d7f3f2bfd6be7b7f4beebe8f1b82fd052ba0ca56df81c7f66dc81825e6281a8153c0628a501be3d91c29cb0003396c5ecf6b0f6c6b5393e1cbe053316
-  data.tar.gz: cbcf09bb50632e1794b7c6095e03e3ef7bb1e7adc97d7538f906cf4e027a59dd9ce1a3e35e1c70e598d285fb813b22b6e1f6a8dcb9556dd6f5fef6d512fb805e
+  metadata.gz: ff4bbc93705cba4f5c4a23308c0890003700c4772c9109899c3b31ea112c75df717153fc65f890dec8ab04b35ba4124646157a35334e94a71541b972afa4b508
+  data.tar.gz: d58a9bdc18dbdc3e9aaebb041db8f1a3741b94c6d47f6499677f8705d528f6f2d9effb69aadbc6793558c67b2608c5f0f0a18e085f20847630dfc9910a1591ad

data/.travis.yml

@@ -1,29 +1,31 @@
 language: ruby
 sudo: false
 
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
+rvm: 2.3
 
 gemfile:
   - gemfiles/Gemfile.activerecord-4.1
+  - gemfiles/Gemfile.activerecord-4.2
+  - gemfiles/Gemfile.activerecord-5.1
+  - gemfiles/Gemfile.activerecord-5.2
+
+services:
+  - mysql
+  - postgresql
 
 env:
   - DB_ADAPTER=sqlite3
   - DB_ADAPTER=mysql2
   - DB_ADAPTER=postgresql
 
+before_install:
+  - gem update --system
+  - gem install bundler
+
 before_script:
   - mysql -e 'create database microscope_test;'
   - psql -c 'create database microscope_test;' -U postgres
 
-script: "echo 'DO IT' && bundle exec rake spec"
-
-notifications:
-  hipchat:
-    rooms:
-      secure: cJWiEh3XNWrEkoeaZd5Kyx3igwOJto+B8jPiyr38Kfv8Z2WLINkHbMQXcd37/tIubX6w9VWjWJ2TuX5cK2H07EraPDDYAHJlnoR/WIPoYwQoXGUWqGH26O2LdBiLs9JcBQ9rKT8K8wmQuxf2rTpY7lN2RoKMjjEjcleWJwQG/3w=
-    template:
-      - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message} (<a href="%{build_url}">Build</a>/<a href="%{compare_url}">Changes</a>)'
-    format: 'html'
+script:
+  - 'echo "Checking code style" && bundle exec phare'
+  - 'echo "Running tests" && bundle exec rake spec'

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2014, Mirego
+Copyright (c) 2013-2019, Mirego
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -1,15 +1,11 @@
-<p align="center">
-  <a href="https://github.com/mirego/microscope">
-    <img src="http://i.imgur.com/JMcAStM.png" alt="Microscope" />
-  </a>
-  <br />
-  Microscope adds useful scopes targeting ActiveRecord <code>boolean</code>, <code>date</code> and <code>datetime</code> fields.
-  <br /><br />
-  <a href="https://rubygems.org/gems/microscope"><img src="http://img.shields.io/gem/v/microscope.svg" /></a>
-  <a href="https://codeclimate.com/github/mirego/microscope"><img src="http://img.shields.io/codeclimate/github/mirego/microscope.svg" /></a>
-  <a href='https://gemnasium.com/mirego/microscope'><img src="http://img.shields.io/gemnasium/mirego/microscope.svg" /></a>
-  <a href="https://travis-ci.org/mirego/microscope"><img src="http://img.shields.io/travis/mirego/microscope.svg" /></a>
-</p>
+<div align="center">
+  <img src="https://user-images.githubusercontent.com/11348/55957273-e1a0a580-5c33-11e9-9eb7-edb896fbbeaf.png" width="600" alt="Microscope" />
+  <p><br />Microscope adds useful scopes targeting ActiveRecord <code>boolean</code>, <code>date</code> and <code>datetime</code> attributes.</p>
+  <p>
+    <a href="https://travis-ci.com/mirego/microscope"><img src="https://travis-ci.com/mirego/microscope.svg?branch=master" /></a>
+    <a href="https://rubygems.org/gems/microscope"><img src="https://img.shields.io/gem/v/microscope.svg" /></a>
+  </p>
+</div>
 
 ---
 
@@ -31,7 +27,7 @@ create_table "events" do |t|
   t.date     "archived_on"
 end
 
-class Event < ActiveRecord::Base
+class Event < ApplicationRecord
   acts_as_microscope
 end
 
@@ -106,12 +102,12 @@ event.archived_at # => 2013-07-05 15:43:42
 You can also use a few options when calling `acts_as_microscope`:
 
 ```ruby
-class Event < ActiveRecord::Base
-  acts_as_microscope, only: [:created_at]
+class Event < ApplicationRecord
+  acts_as_microscope only: [:created_at]
 end
 
-class User < ActiveRecord::Base
-  acts_as_microscope, except: [:created_at]
+class User < ApplicationRecord
+  acts_as_microscope except: [:created_at]
 end
 
 Event.created_before(2.months.ago) # works!
@@ -121,14 +117,62 @@ User.created_before(2.months.ago) # NoMethodError
 User.updated_before(2.months.ago) # works!
 ```
 
+### Date and time attributes and forms
+
+When using Microscope on a `date` or `datetime` attribute, you’ll probably want
+avoid dealing with those values in forms and only expose a checkbox to the
+user.
+
+Setting a Microscope-enabled attribute to a [_truthy_ value](https://github.com/mirego/microscope/blob/master/lib/microscope/utils.rb#L5)
+will correctly cast the attribute to the right value (`Date.today` or `Time.now`, respectively). Otherwise the attribute will
+be set to `nil`.
+
+#### Model
+
+```ruby
+class Event < ApplicationRecord
+  acts_as_microscope
+end
+```
+
+#### View
+
+```erb
+<% form_for @event do |form| %>
+  <%= form.text_field :name %>
+  <%= form.check_box :archived? %>
+
+  <%= submit_tag %>
+<% end %>
+```
+
+#### Controller
+
+```ruby
+class EventsController < ApplicationController
+  def new
+    @event = Event.new
+  end
+
+  def create
+    @event = Event.new(event_params)
+    @event.save
+  end
+
+  def event_params
+    params.require(:event).permit(:name, :archived)
+  end
+end
+```
+
 ## License
 
-`Microscope` is © 2013-2014 [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.
+`Microscope` is © 2013-2019 [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.
 
 The microscope logo is based on [this lovely icon](http://thenounproject.com/noun/microscope/#icon-No9056) by [Scott Lewis](http://thenounproject.com/iconify), from The Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license.
 
 ## About Mirego
 
-[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
+[Mirego](https://www.mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](https://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](https://www.mirego.org).
 
-We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.
+We also [love open-source software](https://open.mirego.com) and we try to give back to the community as much as we can.

data/UPGRADE.md

@@ -0,0 +1,37 @@
+## v1.0
+
+Microscope no longer adds instance methods based on the "imperative" grammatical mood.
+
+It now adds the `mark_as_<verb>!` instance method which does the same thing as
+the `mark_as_<verb>` method but then calls `save!` on the record.
+
+```ruby
+# Before 1.0
+class Event < ActiveRecord::Base
+  acts_as_microscope
+end
+
+event = Event.new(started_on: nil)
+
+event.mark_as_started
+event.started_on # => 2015-02-23T07:58:31-0500
+event.reload.started_on # => nil
+
+event.start!
+event.reload.started_on # => 2015-02-23T07:58:31-0500
+
+# After 1.0
+class Event < ActiveRecord::Base
+  acts_as_microscope
+end
+
+event = Event.new(started_on: nil)
+
+event.mark_as_started
+event.started_on # => 2015-02-23T07:58:31-0500
+event.reload.started_on # => nil
+
+event.start! # NoMethodError
+event.mark_as_started!
+event.reload.started_on # => 2015-02-23T07:58:32-0500
+```

data/gemfiles/Gemfile.activerecord-4.1

@@ -3,3 +3,6 @@ source 'https://rubygems.org'
 gemspec path: '../'
 
 gem 'activerecord', '~> 4.1.0'
+gem 'sqlite3', '~> 1.3.6'
+gem 'mysql2', '~> 0.3.0'
+gem 'pg', '~> 0.15.0'

data/gemfiles/Gemfile.activerecord-4.2

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.2.0'
+gem 'sqlite3', '~> 1.3.6'
+gem 'mysql2', '~> 0.4.0'
+gem 'pg', '~> 0.15.0'

data/gemfiles/Gemfile.activerecord-5.1

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 5.1.0'
+gem 'sqlite3', '~> 1.3.6'
+gem 'mysql2', '~> 0.4.0'
+gem 'pg', '~> 0.18.0'

data/gemfiles/Gemfile.activerecord-5.2

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 5.2.0'
+gem 'sqlite3', '~> 1.3.6'
+gem 'mysql2', '~> 0.4.0'
+gem 'pg', '~> 0.18.0'

data/lib/microscope/instance_method/datetime_instance_method.rb

@@ -11,7 +11,7 @@ module Microscope
       def apply
         @cropped_field = field.name.gsub(@cropped_field_regex, '')
 
-        model.class_eval(apply_methods) if @field_name =~ @cropped_field_regex
+        model.class_eval(apply_methods) if @field.name =~ @cropped_field_regex
       end
 
     protected

data/lib/microscope/instance_method.rb

@@ -1,12 +1,14 @@
 module Microscope
-  class InstanceMethod < Struct.new(:model, :field)
-    def initialize(*args)
-      super
-      @field_name = field.name
+  class InstanceMethod
+    attr_reader :model, :field
+
+    def initialize(model, field)
+      @model = model
+      @field = field
     end
 
     def cropped_field
-      @cropped_field ||= @field_name.gsub(@cropped_field_regex, '')
+      @cropped_field ||= @field.name.gsub(@cropped_field_regex, '')
     end
 
     # Inject ActiveRecord scopes into a model

data/lib/microscope/scope/boolean_scope.rb

@@ -2,10 +2,12 @@ module Microscope
   class Scope
     class BooleanScope < Scope
       def apply
+        validate_field_name!(@field.name, @field.name)
+
         model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          scope "#{@field_name}", lambda { where("#{@field_name}" => true) }
-          scope "not_#{@field_name}", lambda { where("#{@field_name}" => false) }
-          scope "un#{@field_name}", lambda { not_#{@field_name} }
+          scope "#{@field.name}", lambda { where("#{@field.name}" => true) }
+          scope "not_#{@field.name}", lambda { where("#{@field.name}" => false) }
+          scope "un#{@field.name}", lambda { not_#{@field.name} }
         RUBY
       end
     end

data/lib/microscope/scope/datetime_scope.rb

@@ -12,7 +12,10 @@ module Microscope
       end
 
       def apply
-        model.class_eval(apply_scopes) if @field_name =~ @cropped_field_regex
+        return unless @field.name =~ @cropped_field_regex
+
+        validate_field_name!(cropped_field, @field.name)
+        model.class_eval(apply_scopes)
       end
 
     private
@@ -29,7 +32,7 @@ module Microscope
           scope "#{cropped_field}_after#{@now_suffix}", lambda { where('#{quoted_field} > ?', #{@now}) }
           scope "#{cropped_field}_after_or#{@now_suffix}", lambda { where('#{quoted_field} >= ?', #{@now}) }
 
-          scope "#{cropped_field}_between", lambda { |range| where("#{@field_name}" => range) }
+          scope "#{cropped_field}_between", lambda { |range| where("#{@field.name}" => range) }
 
           scope "#{cropped_field}", lambda { where('#{quoted_field} IS NOT NULL AND #{quoted_field} <= ?', #{@now}) }
           scope "not_#{cropped_field}", lambda { where('#{quoted_field} IS NULL OR #{quoted_field} > ?', #{@now}) }

data/lib/microscope/scope.rb

@@ -1,18 +1,18 @@
 module Microscope
-  class Scope < Struct.new(:model, :field)
-    def initialize(*args)
-      super
+  class Scope
+    attr_reader :model, :field
 
-      @field_name = field.name
-      @table_name = model.name.tableize
+    def initialize(model, field)
+      @model = model
+      @field = field
     end
 
     def quoted_field
-      @quoted_field ||= "#{ActiveRecord::Base.connection.quote_table_name(@table_name)}.#{ActiveRecord::Base.connection.quote_column_name(@field_name)}"
+      @quoted_field ||= "#{ActiveRecord::Base.connection.quote_table_name(@model.table_name)}.#{ActiveRecord::Base.connection.quote_column_name(@field.name)}"
     end
 
     def cropped_field
-      @cropped_field ||= @field_name.gsub(@cropped_field_regex, '')
+      @cropped_field ||= @field.name.gsub(@cropped_field_regex, '')
     end
 
     # Inject ActiveRecord scopes into a model
@@ -22,5 +22,17 @@ module Microscope
         "Microscope::Scope::#{scope}".constantize.new(model, field).apply if const_defined?(scope)
       end
     end
+
+  protected
+
+    def blacklisted_fields
+      return [] unless defined? ActiveRecord::AttributeMethods::BLACKLISTED_CLASS_METHODS
+
+      ActiveRecord::AttributeMethods::BLACKLISTED_CLASS_METHODS
+    end
+
+    def validate_field_name!(cropped_field_name, field_name)
+      raise Microscope::BlacklistedColumnsError, Microscope::BlacklistedColumnsErrorMessage % field_name if blacklisted_fields.include?(cropped_field_name)
+    end
   end
 end

data/lib/microscope/version.rb

@@ -1,3 +1,3 @@
 module Microscope
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end

data/lib/microscope.rb

@@ -17,6 +17,11 @@ require 'microscope/instance_method/datetime_instance_method'
 require 'microscope/instance_method/date_instance_method'
 
 module Microscope
+  # Constants
+  BlacklistedColumnsErrorMessage = 'The `%s` column cannot be used with Microscope because it’s on ActiveRecord’s method name blacklist.'.freeze
+
+  # Errors
+  BlacklistedColumnsError = Class.new(StandardError)
 end
 
 module ActiveRecord
@@ -33,6 +38,8 @@ module ActiveRecord
 
       Microscope::Scope.inject_scopes(self, model_columns, options)
       Microscope::InstanceMethod.inject_instance_methods(self, model_columns, options)
+    rescue ActiveRecord::ActiveRecordError
+      nil
     end
   end
 end

data/microscope.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Microscope::VERSION
   spec.authors       = ['Simon Prévost', 'Rémi Prévost', 'Samuel Garneau']
   spec.email         = ['sprevost@mirego.com', 'rprevost@mirego.com', 'sgarneau@mirego.com']
-  spec.description   = 'Microscope adds useful scopes targeting ActiveRecord boolean and datetime fields.'
+  spec.description   = 'Microscope adds useful scopes targeting ActiveRecord boolean and datetime attributes.'
   spec.summary       = spec.description
   spec.homepage      = 'https://github.com/mirego/microscope'
   spec.license       = 'BSD 3-Clause'
@@ -18,15 +18,12 @@ Gem::Specification.new do |spec|
   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_dependency 'activesupport', '>= 4.1.0'
+  spec.add_dependency 'activerecord', '>= 4.1.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.1'
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'pg'
-  spec.add_development_dependency 'mysql2', '~> 0.3.13'
-  spec.add_development_dependency 'rubocop', '~> 0.28'
+  spec.add_development_dependency 'rubocop', '0.29'
   spec.add_development_dependency 'phare'
 end

data/spec/microscope/instance_method/datetime_instance_method_spec.rb

@@ -42,7 +42,7 @@ describe Microscope::InstanceMethod::DatetimeInstanceMethod do
 
     context 'with present argument, twice' do
       let(:event) { Event.create(started_at: time) }
-      let(:time) { 2.months.ago }
+      let(:time) { 2.months.ago.beginning_of_hour }
       let(:value) { '1' }
 
       it { expect(event.started_at).to eql time }

data/spec/microscope/scope/boolean_scope_spec.rb

@@ -1,34 +1,50 @@
 require 'spec_helper'
 
 describe Microscope::Scope::BooleanScope do
-  before do
-    run_migration do
-      create_table(:users, force: true) do |t|
-        t.boolean :active, default: false
+  describe 'for a valid column name' do
+    before do
+      run_migration do
+        create_table(:oh_users, force: true) do |t|
+          t.boolean :active, default: false
+        end
+      end
+
+      microscope 'User' do
+        self.table_name = 'oh_users'
       end
     end
 
-    microscope 'User'
-  end
+    describe 'positive scope' do
+      before do
+        @user1 = User.create(active: true)
+        @user2 = User.create(active: false)
+      end
 
-  describe 'positive scope' do
-    before do
-      @user1 = User.create(active: true)
-      @user2 = User.create(active: false)
+      it { expect(User.active.length).to eql 1 }
+      it { expect(User.active).to include(@user1) }
     end
 
-    it { expect(User.active.length).to eql 1 }
-    it { expect(User.active).to include(@user1) }
+    describe 'negative scope' do
+      before do
+        @user1 = User.create(active: false)
+        @user2 = User.create(active: true)
+      end
+
+      it { expect(User.not_active.length).to eql 1 }
+      it { expect(User.not_active).to include(@user1) }
+      it { expect(User.unactive.to_a).to eql User.not_active.to_a }
+    end
   end
 
-  describe 'negative scope' do
+  describe 'for a invalid column name' do
     before do
-      @user1 = User.create(active: false)
-      @user2 = User.create(active: true)
+      run_migration do
+        create_table(:users, force: true) do |t|
+          t.boolean :public, default: false
+        end
+      end
     end
 
-    it { expect(User.not_active.length).to eql 1 }
-    it { expect(User.not_active).to include(@user1) }
-    it { expect(User.unactive.to_a).to eql User.not_active.to_a }
+    it { expect { microscope 'User' }.to raise_error(Microscope::BlacklistedColumnsError) }
   end
 end

data/spec/microscope/scope/date_scope_spec.rb

@@ -1,150 +1,164 @@
 require 'spec_helper'
 
 describe Microscope::Scope::DateScope do
-  before do
-    run_migration do
-      create_table(:events, force: true) do |t|
-        t.date :started_on, default: nil
-        t.date :published_date, default: nil
+  describe 'for a valid column name' do
+    before do
+      run_migration do
+        create_table(:events, force: true) do |t|
+          t.date :started_on, default: nil
+          t.date :published_date, default: nil
+        end
       end
+
+      microscope 'Event'
     end
 
-    microscope 'Event'
-  end
+    describe 'before scope' do
+      before do
+        @event = Event.create(started_on: 2.months.ago)
+        Event.create(started_on: 1.month.from_now)
+      end
 
-  describe 'before scope' do
-    before do
-      @event = Event.create(started_on: 2.months.ago)
-      Event.create(started_on: 1.month.from_now)
+      it { expect(Event.started_before(1.month.ago).to_a).to eql [@event] }
     end
 
-    it { expect(Event.started_before(1.month.ago).to_a).to eql [@event] }
-  end
+    describe 'before_or_on scope' do
+      let(:date) { 2.months.ago }
 
-  describe 'before_or_on scope' do
-    let(:date) { 2.months.ago }
+      before do
+        @event1 = Event.create(started_on: date)
+        @event2 = Event.create(started_on: date - 1.day)
+        Event.create(started_on: 1.month.from_now)
+      end
 
-    before do
-      @event1 = Event.create(started_on: date)
-      @event2 = Event.create(started_on: date - 1.day)
-      Event.create(started_on: 1.month.from_now)
+      it { expect(Event.started_before_or_on(date).to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started_before_or_on(date).to_a).to eql [@event1, @event2] }
-  end
+    describe 'before_or_now scope' do
+      let(:stubbed_date) { Date.today + 1.year }
+      before { allow(Date).to receive(:today).and_return(stubbed_date) }
 
-  describe 'before_or_now scope' do
-    let(:stubbed_date) { Date.parse('2020-03-18 08:00:00') }
-    before { allow(Date).to receive(:today).and_return(stubbed_date) }
+      before do
+        @event1 = Event.create(started_on: stubbed_date)
+        @event2 = Event.create(started_on: stubbed_date - 1.day)
+        Event.create(started_on: stubbed_date + 1.week)
+      end
 
-    before do
-      @event1 = Event.create(started_on: stubbed_date)
-      @event2 = Event.create(started_on: stubbed_date - 1.day)
-      Event.create(started_on: stubbed_date + 1.week)
+      it { expect(Event.started_before_or_today.to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started_before_or_today.to_a).to eql [@event1, @event2] }
-  end
+    describe 'before_today scope' do
+      before do
+        @event = Event.create(started_on: 2.months.ago)
+        Event.create(started_on: 1.month.from_now)
+      end
 
-  describe 'before_today scope' do
-    before do
-      @event = Event.create(started_on: 2.months.ago)
-      Event.create(started_on: 1.month.from_now)
+      it { expect(Event.started_before_today.to_a).to eql [@event] }
     end
 
-    it { expect(Event.started_before_today.to_a).to eql [@event] }
-  end
+    describe 'after scope' do
+      before do
+        @event = Event.create(started_on: 2.months.from_now)
+        Event.create(started_on: 1.month.ago)
+      end
 
-  describe 'after scope' do
-    before do
-      @event = Event.create(started_on: 2.months.from_now)
-      Event.create(started_on: 1.month.ago)
+      it { expect(Event.started_after(1.month.from_now).to_a).to eql [@event] }
     end
 
-    it { expect(Event.started_after(1.month.from_now).to_a).to eql [@event] }
-  end
+    describe 'after_or_on scope' do
+      let(:date) { 2.months.from_now }
 
-  describe 'after_or_on scope' do
-    let(:date) { 2.months.from_now }
+      before do
+        @event1 = Event.create(started_on: date)
+        @event2 = Event.create(started_on: date + 1.day)
+        Event.create(started_on: 1.month.ago)
+      end
 
-    before do
-      @event1 = Event.create(started_on: date)
-      @event2 = Event.create(started_on: date + 1.day)
-      Event.create(started_on: 1.month.ago)
+      it { expect(Event.started_after_or_on(date).to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started_after_or_on(date).to_a).to eql [@event1, @event2] }
-  end
+    describe 'after_or_now scope' do
+      let(:stubbed_date) { Date.today + 1.year }
+      before { allow(Date).to receive(:today).and_return(stubbed_date) }
 
-  describe 'after_or_now scope' do
-    let(:stubbed_date) { Date.parse('2020-03-18 08:00:00') }
-    before { allow(Date).to receive(:today).and_return(stubbed_date) }
+      before do
+        @event1 = Event.create(started_on: stubbed_date)
+        @event2 = Event.create(started_on: stubbed_date + 1.day)
+        Event.create(started_on: 1.month.ago)
+      end
 
-    before do
-      @event1 = Event.create(started_on: stubbed_date)
-      @event2 = Event.create(started_on: stubbed_date + 1.day)
-      Event.create(started_on: 1.month.ago)
+      it { expect(Event.started_after_or_today.to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started_after_or_today.to_a).to eql [@event1, @event2] }
-  end
+    describe 'after_today scope' do
+      before do
+        @event = Event.create(started_on: 2.months.from_now)
+        Event.create(started_on: 1.month.ago)
+      end
 
-  describe 'after_today scope' do
-    before do
-      @event = Event.create(started_on: 2.months.from_now)
-      Event.create(started_on: 1.month.ago)
+      it { expect(Event.started_after_today.to_a).to eql [@event] }
     end
 
-    it { expect(Event.started_after_today.to_a).to eql [@event] }
-  end
+    describe 'between scope' do
+      before do
+        Event.create(started_on: 1.month.ago)
+        @event = Event.create(started_on: 3.months.ago)
+        Event.create(started_on: 5.month.ago)
+      end
 
-  describe 'between scope' do
-    before do
-      Event.create(started_on: 1.month.ago)
-      @event = Event.create(started_on: 3.months.ago)
-      Event.create(started_on: 5.month.ago)
+      it { expect(Event.started_between(4.months.ago..2.months.ago).to_a).to eql [@event] }
     end
 
-    it { expect(Event.started_between(4.months.ago..2.months.ago).to_a).to eql [@event] }
-  end
+    describe 'super-boolean positive scope' do
+      before do
+        @event1 = Event.create(started_on: 1.month.ago)
+        @event2 = Event.create(started_on: 3.months.ago)
+        Event.create(started_on: 2.months.from_now)
+        Event.create(started_on: nil)
+      end
 
-  describe 'super-boolean positive scope' do
-    before do
-      @event1 = Event.create(started_on: 1.month.ago)
-      @event2 = Event.create(started_on: 3.months.ago)
-      Event.create(started_on: 2.months.from_now)
-      Event.create(started_on: nil)
+      it { expect(Event.started.to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started.to_a).to eql [@event1, @event2] }
-  end
+    describe 'super-boolean negative scope' do
+      before do
+        Event.create(started_on: 1.month.ago)
+        Event.create(started_on: 3.months.ago)
+        @event1 = Event.create(started_on: 2.months.from_now)
+        @event2 = Event.create(started_on: nil)
+      end
 
-  describe 'super-boolean negative scope' do
-    before do
-      Event.create(started_on: 1.month.ago)
-      Event.create(started_on: 3.months.ago)
-      @event1 = Event.create(started_on: 2.months.from_now)
-      @event2 = Event.create(started_on: nil)
+      it { expect(Event.not_started.to_a).to eql [@event1, @event2] }
+      it { expect(Event.unstarted.to_a).to eql Event.not_started.to_a }
     end
 
-    it { expect(Event.not_started.to_a).to eql [@event1, @event2] }
-    it { expect(Event.unstarted.to_a).to eql Event.not_started.to_a }
-  end
+    describe 'boolean instance method' do
+      context 'for positive record' do
+        let(:event) { Event.create(started_on: 3.months.ago) }
+        it { expect(event).to be_started }
+      end
 
-  describe 'boolean instance method' do
-    context 'for positive record' do
-      let(:event) { Event.create(started_on: 3.months.ago) }
-      it { expect(event).to be_started }
+      context 'for negative record' do
+        let(:event) { Event.create(started_on: 2.months.from_now) }
+        it { expect(event).to_not be_started }
+      end
     end
 
-    context 'for negative record' do
-      let(:event) { Event.create(started_on: 2.months.from_now) }
-      it { expect(event).to_not be_started }
+    context 'for field that does not match the pattern' do
+      it { expect(Event).to_not respond_to(:published_date) }
+      it { expect(Event).to_not respond_to(:not_published_date) }
     end
   end
 
-  context 'for field that does not match the pattern' do
-    it { expect(Event).to_not respond_to(:published_date) }
-    it { expect(Event).to_not respond_to(:not_published_date) }
+  describe 'for a invalid column name' do
+    before do
+      run_migration do
+        create_table(:events, force: true) do |t|
+          t.date :public_on, default: nil
+        end
+      end
+    end
+
+    it { expect { microscope 'Event' }.to raise_error(Microscope::BlacklistedColumnsError) }
   end
 end

data/spec/microscope/scope/datetime_scope_spec.rb

@@ -1,150 +1,164 @@
 require 'spec_helper'
 
 describe Microscope::Scope::DatetimeScope do
-  before do
-    run_migration do
-      create_table(:events, force: true) do |t|
-        t.datetime :started_at, default: nil
-        t.datetime :published_date, default: nil
+  describe 'for a valid column name' do
+    before do
+      run_migration do
+        create_table(:events, force: true) do |t|
+          t.datetime :started_at, default: nil
+          t.datetime :published_date, default: nil
+        end
       end
+
+      microscope 'Event'
     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
 
-  describe 'before scope' do
-    before do
-      @event = Event.create(started_at: 2.months.ago)
-      Event.create(started_at: 1.month.from_now)
+      it { expect(Event.started_before(1.month.ago).to_a).to eql [@event] }
     end
 
-    it { expect(Event.started_before(1.month.ago).to_a).to eql [@event] }
-  end
+    describe 'before_or_at scope' do
+      let(:datetime) { 1.month.ago }
 
-  describe 'before_or_at scope' do
-    let(:datetime) { 1.month.ago }
+      before do
+        @event1 = Event.create(started_at: datetime)
+        @event2 = Event.create(started_at: datetime - 1.second)
+        Event.create(started_at: 1.month.from_now)
+      end
 
-    before do
-      @event1 = Event.create(started_at: datetime)
-      @event2 = Event.create(started_at: datetime - 1.second)
-      Event.create(started_at: 1.month.from_now)
+      it { expect(Event.started_before_or_at(datetime).to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started_before_or_at(datetime).to_a).to eql [@event1, @event2] }
-  end
+    describe 'before_or_now scope' do
+      let(:stubbed_date) { Time.parse('2020-03-18 08:00:00') }
+      before { allow(Time).to receive(:now).and_return(stubbed_date) }
 
-  describe 'before_or_now scope' do
-    let(:stubbed_date) { Time.parse('2020-03-18 08:00:00') }
-    before { allow(Time).to receive(:now).and_return(stubbed_date) }
+      before do
+        @event1 = Event.create(started_at: stubbed_date)
+        @event2 = Event.create(started_at: stubbed_date - 1.second)
+        Event.create(started_at: 1.month.from_now)
+      end
 
-    before do
-      @event1 = Event.create(started_at: stubbed_date)
-      @event2 = Event.create(started_at: stubbed_date - 1.second)
-      Event.create(started_at: 1.month.from_now)
+      it { expect(Event.started_before_or_now.to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started_before_or_now.to_a).to eql [@event1, @event2] }
-  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
 
-  describe 'before_now scope' do
-    before do
-      @event = Event.create(started_at: 2.months.ago)
-      Event.create(started_at: 1.month.from_now)
+      it { expect(Event.started_before_now.to_a).to eql [@event] }
     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
 
-  describe 'after scope' do
-    before do
-      @event = Event.create(started_at: 2.months.from_now)
-      Event.create(started_at: 1.month.ago)
+      it { expect(Event.started_after(1.month.from_now).to_a).to eql [@event] }
     end
 
-    it { expect(Event.started_after(1.month.from_now).to_a).to eql [@event] }
-  end
+    describe 'after_or_at scope' do
+      let(:datetime) { 1.month.from_now.beginning_of_hour }
 
-  describe 'after_or_at scope' do
-    let(:datetime) { 1.month.from_now }
+      before do
+        @event1 = Event.create(started_at: datetime)
+        @event2 = Event.create(started_at: datetime + 1.second)
+        Event.create(started_at: 1.month.ago)
+      end
 
-    before do
-      @event1 = Event.create(started_at: datetime)
-      @event2 = Event.create(started_at: datetime + 1.second)
-      Event.create(started_at: 1.month.ago)
+      it { expect(Event.started_after_or_at(datetime).to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started_after_or_at(datetime).to_a).to eql [@event1, @event2] }
-  end
+    describe 'after_or_now scope' do
+      let(:stubbed_date) { Time.parse('2020-03-18 08:00:00') }
+      before { allow(Time).to receive(:now).and_return(stubbed_date) }
 
-  describe 'after_or_now scope' do
-    let(:stubbed_date) { Time.parse('2020-03-18 08:00:00') }
-    before { allow(Time).to receive(:now).and_return(stubbed_date) }
+      before do
+        @event1 = Event.create(started_at: stubbed_date)
+        @event2 = Event.create(started_at: stubbed_date + 1.second)
+        Event.create(started_at: 1.month.ago)
+      end
 
-    before do
-      @event1 = Event.create(started_at: stubbed_date)
-      @event2 = Event.create(started_at: stubbed_date + 1.second)
-      Event.create(started_at: 1.month.ago)
+      it { expect(Event.started_after_or_now.to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started_after_or_now.to_a).to eql [@event1, @event2] }
-  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
 
-  describe 'after_now scope' do
-    before do
-      @event = Event.create(started_at: 2.months.from_now)
-      Event.create(started_at: 1.month.ago)
+      it { expect(Event.started_after_now.to_a).to eql [@event] }
     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
 
-  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)
+      it { expect(Event.started_between(4.months.ago..2.months.ago).to_a).to eql [@event] }
     end
 
-    it { expect(Event.started_between(4.months.ago..2.months.ago).to_a).to eql [@event] }
-  end
+    describe 'super-boolean positive scope', focus: true do
+      before do
+        @event1 = Event.create(started_at: 1.month.ago)
+        @event2 = Event.create(started_at: 3.months.ago)
+        Event.create(started_at: 2.months.from_now)
+        Event.create(started_at: nil)
+      end
 
-  describe 'super-boolean positive scope', focus: true do
-    before do
-      @event1 = Event.create(started_at: 1.month.ago)
-      @event2 = Event.create(started_at: 3.months.ago)
-      Event.create(started_at: 2.months.from_now)
-      Event.create(started_at: nil)
+      it { expect(Event.started.to_a).to eql [@event1, @event2] }
     end
 
-    it { expect(Event.started.to_a).to eql [@event1, @event2] }
-  end
+    describe 'super-boolean negative scope' do
+      before do
+        Event.create(started_at: 1.month.ago)
+        Event.create(started_at: 3.months.ago)
+        @event1 = Event.create(started_at: 2.months.from_now)
+        @event2 = Event.create(started_at: nil)
+      end
 
-  describe 'super-boolean negative scope' do
-    before do
-      Event.create(started_at: 1.month.ago)
-      Event.create(started_at: 3.months.ago)
-      @event1 = Event.create(started_at: 2.months.from_now)
-      @event2 = Event.create(started_at: nil)
+      it { expect(Event.not_started.to_a).to eql [@event1, @event2] }
+      it { expect(Event.unstarted.to_a).to eql Event.not_started.to_a }
     end
 
-    it { expect(Event.not_started.to_a).to eql [@event1, @event2] }
-    it { expect(Event.unstarted.to_a).to eql Event.not_started.to_a }
-  end
+    describe 'boolean instance method' do
+      context 'for positive record' do
+        let(:event) { Event.create(started_at: 3.months.ago) }
+        it { expect(event).to be_started }
+      end
 
-  describe 'boolean instance method' do
-    context 'for positive record' do
-      let(:event) { Event.create(started_at: 3.months.ago) }
-      it { expect(event).to be_started }
+      context 'for negative record' do
+        let(:event) { Event.create(started_at: 2.months.from_now) }
+        it { expect(event).to_not be_started }
+      end
     end
 
-    context 'for negative record' do
-      let(:event) { Event.create(started_at: 2.months.from_now) }
-      it { expect(event).to_not be_started }
+    context 'for field that does not match the pattern' do
+      it { expect(Event).to_not respond_to(:published_date) }
+      it { expect(Event).to_not respond_to(:not_published_date) }
     end
   end
 
-  context 'for field that does not match the pattern' do
-    it { expect(Event).to_not respond_to(:published_date) }
-    it { expect(Event).to_not respond_to(:not_published_date) }
+  describe 'for a invalid column name' do
+    before do
+      run_migration do
+        create_table(:events, force: true) do |t|
+          t.datetime :public_at, default: nil
+        end
+      end
+    end
+
+    it { expect { microscope 'Event' }.to raise_error(Microscope::BlacklistedColumnsError) }
   end
 end

data/spec/microscope_spec.rb

@@ -1,6 +1,17 @@
 require 'spec_helper'
 
 describe Microscope do
+  describe :acts_as_microscope_without_database do
+    specify do
+      adapter = ENV['DB_ADAPTER'] || 'sqlite3'
+      setup_database(adapter: adapter, database: 'microscope_test_that_does_not_exist')
+
+      class User < ActiveRecord::Base
+        acts_as_microscope
+      end
+    end
+  end
+
   describe :acts_as_microscope do
     before do
       run_migration do

data/spec/support/macros/database/mysql2_adapter.rb

@@ -12,5 +12,7 @@ class Mysql2Adapter < DatabaseAdapter
 
   def reset_database!
     ActiveRecord::Base.connection.execute("SELECT concat('DROP TABLE IF EXISTS ', table_name, ';') FROM information_schema.tables WHERE table_schema = '#{@database}';")
+  rescue ActiveRecord::NoDatabaseError
+    nil
   end
 end

data/spec/support/macros/database/postgresql_adapter.rb

@@ -13,5 +13,7 @@ class PostgresqlAdapter < DatabaseAdapter
   def reset_database!
     ActiveRecord::Base.connection.execute('drop schema public cascade;')
     ActiveRecord::Base.connection.execute('create schema public;')
+  rescue ActiveRecord::NoDatabaseError
+    nil
   end
 end

data/spec/support/macros/database_macros.rb

@@ -2,7 +2,11 @@ module DatabaseMacros
   # Run migrations in the test database
   def run_migration(&block)
     # Create a new migration class
-    klass = Class.new(ActiveRecord::Migration)
+    if ActiveRecord.version >= Gem::Version.new('5.0')
+      klass = Class.new(ActiveRecord::Migration[ActiveRecord.version.to_s.to_f])
+    else
+      klass = Class.new(ActiveRecord::Migration)
+    end
 
     # Create a new `up` that executes the argument
     klass.send(:define_method, :up) { instance_exec(&block) }

data/spec/support/macros/model_macros.rb

@@ -2,8 +2,8 @@ module ModelMacros
   # Create a new microscope model
   def microscope(klass_name, options = {}, &block)
     spawn_model klass_name, ActiveRecord::Base do
-      acts_as_microscope options
       instance_exec(&block) if block
+      acts_as_microscope options
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: microscope
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Simon Prévost
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,42 +18,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -82,62 +82,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.13
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.29'
 - !ruby/object:Gem::Dependency
   name: phare
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +111,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Microscope adds useful scopes targeting ActiveRecord boolean and datetime
-  fields.
+  attributes.
 email:
 - sprevost@mirego.com
 - rprevost@mirego.com
@@ -170,7 +128,11 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- UPGRADE.md
 - gemfiles/Gemfile.activerecord-4.1
+- gemfiles/Gemfile.activerecord-4.2
+- gemfiles/Gemfile.activerecord-5.1
+- gemfiles/Gemfile.activerecord-5.2
 - lib/microscope.rb
 - lib/microscope/instance_method.rb
 - lib/microscope/instance_method/boolean_instance_method.rb
@@ -216,12 +178,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Microscope adds useful scopes targeting ActiveRecord boolean and datetime
-  fields.
+  attributes.
 test_files:
 - spec/microscope/instance_method/boolean_instance_method_spec.rb
 - spec/microscope/instance_method/date_instance_method_spec.rb