active_record_mocks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88990a18f8fe9b7a17990eb080e7a8e15978997b
+  data.tar.gz: d44b699b89a26142df44a62ed86ab10f774bf1c1
+SHA512:
+  metadata.gz: aae5f6701fb3066ea610c9b6ce3ea9b0d04e3aab5c8c0094afa46dd0c7865f1bf03191a9e2ea2e64d02487721228fadd301dc9b23c21cba5651b71899443bff7
+  data.tar.gz: 7b7f0ba4382f1e25a4633dd68c634cfbd272bba1546619fcad78f9538b7ba5dff27f29961916ebb54b7a2d9a13fa25bbd824bda7b7ce8b89861687d6b24d13d3

data/Gemfile

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+gemspec :name => "Gem1"
+
+group :development do
+  unless ENV["CI"]
+    gem "pry"
+  end
+
+  gem "rake"
+
+  # ---------------------------------------------------------------------------
+  # So we can test a bunch of database platforms.
+  # ---------------------------------------------------------------------------
+
+  gem "pg", :platforms => [:mswin, :mingw, :ruby]
+  gem "activerecord-jdbcpostgresql-adapter", :platforms => :jruby
+  gem "activerecord-jdbcmysql-adapter", :platforms => :jruby
+  gem "mysql2", :platforms => [:mswin, :mingw, :ruby]
+end

data/License

@@ -0,0 +1,11 @@
+Copyright 2013 Jordon Bedwell
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this file except in compliance with the License. You may obtain a copy of
+the License at: http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations under
+the License.

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+task :default => [:spec]
+task :test => :spec
+RSpec::Core::RakeTask.new :spec

data/Readme.md

@@ -0,0 +1,149 @@
+# Active Record Mocks.
+
+[![Build Status](https://travis-ci.org/envygeeks/active_record_mocks.png?branch=master)](https://travis-ci.org/envygeeks/active_record_mocks) [![Coverage Status](https://coveralls.io/repos/envygeeks/active_record_mocks/badge.png?branch=master)](https://coveralls.io/r/envygeeks/active_record_mocks) [![Code Climate](https://codeclimate.com/github/envygeeks/active_record_mocks.png)](https://codeclimate.com/github/envygeeks/active_record_mocks) [![Dependency Status](https://gemnasium.com/envygeeks/active_record_mocks.png)](https://gemnasium.com/envygeeks/active_record_mocks)
+
+ActiveRecord Mocks is designed to aide you in testing your ActiveRecord
+concerns by creating random models (or even named models) that are
+removed after each test.  It was originally concieved to test concerns,
+includes and other types of things that normally aren't tied to a
+model specifically.
+
+## Installing
+
+```ruby
+gem "active_record_mocks"
+```
+
+## Using
+
+```ruby
+with_mocked_tables do |m|
+  m.enable_extension "uuid-ossp"
+  m.enable_extension "hstore"
+
+  t1 = m.create_table do |t|
+    t.model_name :Foo
+    t.belongs_to :bar
+
+    t.layout do |l|
+       l.integer :bar_id
+    end
+  end
+
+  t2 = m.create_table do |t|
+    t.model_name :Bar
+    t.has_many   :foo
+
+    t.layout do |l|
+      l.text :bar_text
+    end
+  end
+
+  # Do Work Here
+end
+```
+
+---
+
+### Extensions
+
+You can enable PostgreSQL extensions inside of your models using the
+`enable_extension` method when inside of `with_mocked_tables` or
+`with_mocked_models` like so:
+
+```ruby
+with_mocked_tables do |m|
+  m.enable_extension "extension-name"
+end
+```
+
+---
+
+### Creating Tables and Layouts
+
+To create tables you use the `create_table` method when inside of
+`with_mocked_tables` or `with_mocked_models`, like so:
+
+```ruby
+with_mocked_tables do |m|
+  m.create_table migration_arguments do |t|
+    t.layout do |l|
+      l.text :foo_text
+    end
+  end
+end
+```
+
+#### Belongs to, Has Many and other methods
+
+Any method that `ActiveRecordMocks` does not know or understand is
+passed on to the model itself, so if you need for example `belongs_to`
+then you would simply use belongs to when creating your table:
+
+```ruby
+with_mocked_tables do |m|
+  m.create_table migration_arguments do |t|
+    t.belongs_to :bar_model
+    t.layout do |l|
+      l.text :foo_text
+    end
+  end
+end
+```
+
+#### Named models and tables
+
+If you need a named model or a named table or a model whose table is
+different than it's model you can use the methods `model_name` and
+`table_name`, if you simply need a named model and you use standard
+naming conventions than you can simply leave out the `table_name`
+when using model name and `ActiveRecordMocks` will tabelize the name
+of your model automatically the same as `Rails` would.
+
+```ruby
+with_mocked_tables do |m|
+  t1 = m.create_table migration_arguments do |t|
+    t.model_name :Foo
+    t.layout do |l|
+      l.text :foo_text
+    end
+  end
+end
+
+# Results in:
+#   - Foo  (Model)
+#   - foos (Table)
+```
+
+```ruby
+with_mocked_tables do |m|
+  t1 = m.create_table migration_arguments do |t|
+    t.table_name :old_foo
+    t.model_name :Foo
+    t.layout do |l|
+      l.text :foo_text
+    end
+  end
+end
+
+# Results in:
+#   - Foo      (Model)
+#   - old_foo  (Table)
+```
+
+#### Model Includes
+
+If you need to include anything into your model you can use the
+`includes` method when inside of `with_mocked_models` or
+`with_mocked_tables`, like so:
+
+```ruby
+with_mocked_tables do |m|
+  m.create_table migration_arguments do |t|
+    t.includes Bar1, Bar2
+    t.layout do |l|
+      l.text :foo_text
+    end
+  end
+end
+```

data/lib/active_record_mocks/mock/table.rb

@@ -0,0 +1,148 @@
+require "active_support/core_ext/string/inflections"
+
+module ActiveRecordMocks
+  class Mock
+    class Table
+      attr_reader :model_methods
+      attr_reader :args
+
+      def initialize(*args, &block)
+        @model_methods = []
+        @table_name = nil
+        @includes = []
+        @args = args
+        @layout = nil
+        @model_name = nil
+      end
+
+      # ---------------------------------------------------------------
+      # Tells us if we have already setup this model and object so
+      # that we don't keep setting stuff up.
+      # ---------------------------------------------------------------
+
+      def setup?
+        @already_setup ? true : false
+      end
+
+      # ---------------------------------------------------------------
+      # Gives the proper object of the model for you.
+      # ---------------------------------------------------------------
+
+      def model
+        if setup?
+          Object.const_get(@model_name)
+        end
+      end
+
+      # ---------------------------------------------------------------
+      # Allows you to set the files that should be included into the
+      # model, you must use t.includes because t.include is already
+      # a method on the object you are in.
+      # ---------------------------------------------------------------
+
+      def includes(*incs)
+        if setup? || incs.size == 0
+          @includes
+        else
+          incs.each do |i|
+            unless i.blank?
+              @includes.push(i)
+            end
+          end
+        end
+      end
+
+      # ---------------------------------------------------------------
+      # Allows you to set the layout for the table you are building.
+      # ---------------------------------------------------------------
+
+      def layout(&block)
+        setup? || ! block_given? ? @layout ||= nil : @layout = block
+      end
+
+      # ---------------------------------------------------------------
+      # Allows the setting of or setuping up of and returning of the
+      # name of the table that is being used for the model.  If
+      # you do not customize this then it will be a tabelized name
+      # of the model, the same way that normal active_record would do.
+      # ---------------------------------------------------------------
+
+      def table_name(tname = nil)
+        if setup? || (! tname && @table_name)
+          @table_name
+        else
+          @table_name = \
+            tname ? tname : model_name.to_s.tableize
+        end
+      end
+
+      # ---------------------------------------------------------------
+      # Allows for the setting of or setup of and returning of the name
+      # of the model being used, this should not be confused with model
+      # which returns the actual object.  The model need not match the
+      # table and sometimes it won't if you chose to be that way.
+      # ---------------------------------------------------------------
+
+      def model_name(mname = nil)
+        if setup? || (! mname && @model_name)
+          @model_name
+        else
+          @model_name = mname ? mname : \
+            SecureRandom.hex(10).tr("^a-z", "").capitalize
+        end
+      end
+
+      def setup_mocking!
+        if ! setup?
+          setup_table!
+          setup_model!
+          @already_setup = true
+        end
+      end
+
+      private
+      def setup_table!
+        ActiveRecord::Migration.tap do |o|
+          o.suppress_messages do
+            o.create_table table_name, *args do |t|
+              layout.call(t) if layout.is_a?(Proc)
+            end
+          end
+        end
+      end
+
+      private
+      def setup_model!
+        Object.const_set(model_name,
+            Class.new(ActiveRecord::Base)).tap do |o|
+          o.table_name = table_name
+          setup_includes(o)
+          run_model_methods(o)
+        end
+      end
+
+      private
+      def setup_includes(obj)
+        includes.each do |i|
+          obj.send(:include, i)
+        end
+      end
+
+      private
+      def run_model_methods(obj)
+        model_methods.each do |m|
+          obj.send(m[:method], *m[:args], &m[:block])
+        end
+      end
+
+      public
+      def method_missing(methud, *args, &block)
+        model_methods.push({
+          :block => block,
+          :method => methud,
+          :args => args
+        })
+      end
+    end
+  end
+end

data/lib/active_record_mocks/mock.rb

@@ -0,0 +1,55 @@
+require_relative "mock/table"
+require "active_record"
+
+module ActiveRecordMocks
+  class Mock
+    class ExtensionsUnsupported < StandardError
+      def initialize
+        super "Your database server does not support extensions."
+      end
+    end
+
+    attr_accessor :tables
+
+    def enable_extension(ext)
+      raise_if_extensions_unsupported!
+      ActiveRecord::Migration.tap do |o|
+        o.suppress_messages do
+          o.enable_extension(ext)
+        end
+      end
+    end
+
+    def create_table(*args, &block)
+      Table.new(*args).tap do |o|
+        if block_given?
+          block.call(o)
+        end
+
+        o.setup_mocking!
+        tables.push(o)
+        return o.model
+      end
+    end
+
+    def initialize
+      @tables = [
+      ]
+    end
+
+    def delete_tables
+      tables.each do |t|
+        Object.send(:remove_const, t.model_name)
+        ActiveRecord::Base.connection.drop_table(t.table_name)
+      end
+    nil
+    end
+
+    private
+    def raise_if_extensions_unsupported!
+      if ! ActiveRecord::Base.connection.respond_to?(:enable_extension)
+        raise ExtensionsUnsupported
+      end
+    end
+  end
+end

data/lib/active_record_mocks/rails.rb

@@ -0,0 +1,5 @@
+require_relative "../active_record_mocks"
+
+class ActiveSupport::TestCase
+  include ActiveRecordMocks::IncludeMe
+end

data/lib/active_record_mocks/rspec.rb

@@ -0,0 +1,6 @@
+require_relative "../active_record_mocks"
+require "rspec"
+
+RSpec.configure do |config|
+  config.include ActiveRecordMocks::IncludeMe
+end

data/lib/active_record_mocks/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordMocks
+  VERSION = "1.0.0"
+end

data/lib/active_record_mocks.rb

@@ -0,0 +1,21 @@
+require "active_record"
+
+module ActiveRecordMocks
+  require_relative "active_record_mocks/mock"
+
+  module IncludeMe
+    def mocked_active_record
+      Mock.new
+    end
+
+    def with_mocked_tables(&block)
+      if block_given?
+        mocked_active_record.tap do |o|
+          block.call(o)
+          o.delete_tables
+        end
+      end
+    nil
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: active_record_mocks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jordon Bedwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-expect_error
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: envygeeks-coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: luna-rspec-formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Mock ActiveRecord tables to test concerns and other code.
+email: envygeeks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.md
+- License
+- Rakefile
+- Gemfile
+- lib/active_record_mocks.rb
+- lib/active_record_mocks/rails.rb
+- lib/active_record_mocks/version.rb
+- lib/active_record_mocks/mock/table.rb
+- lib/active_record_mocks/mock.rb
+- lib/active_record_mocks/rspec.rb
+homepage: https://github.com/envygeeks/active_record_mocks
+licenses:
+- Apache 2.0
+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.3
+signing_key: 
+specification_version: 4
+summary: Mock ActiveRecord tables to test.
+test_files: []