remote_db 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 897782b1480916843610989aeab9f14c1709090e
-  data.tar.gz: fbb1d2b9d1d22335a7a72fe7bbd8461131e0c744
+  metadata.gz: 667d1745cc359f830957af95e1528e639c7fea55
+  data.tar.gz: c2f1d5197e58042fdbcc760c638440dceb0c5c2b
 SHA512:
-  metadata.gz: 29bce29570019e4e55d7ecdadf7bffdde33caddab0bbf428ce3c105caa1dc45d5bad6b5f39503ab653a3999a1b9af5f97f3bd9ff0326f5206ae07528ba910e99
-  data.tar.gz: d6e08127decae61c17ed6bcbac541de4dcb5e461817f2ff3a31fc24da6448613a0626393b0d8c04653b96bfdcb12cf6ad9ae2e7d3c4200b36881628a5906fe5d
+  metadata.gz: 0af7222de66fc8405b753d6bbe7269915571e871f012521939fb7d544755dd41fe0012f9dc07552256e59777b99b99f1d21e057f175ff23fa5ed42d73d2d6409
+  data.tar.gz: dd258c4a4234fef195cfa4f5250d096c7aa877e3902a75d540ba23f92b309ef0b7ef9d8f0ac8c4e2b7585dbdacaefcb6a5408433b30be12d0abefa0282ba03fb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-## v0.0.1
+## v0.0.5
 
-* Initial release.
+* Models can now be reloaded.
+* In test environment, models can temporarily be switch to read-write mode.
+* Added tests
+
+## v0.0.4
 
-## v0.0.2
+* Fix bug with AR 4, where AR classes must be named.
 
-* Fix bug with AR 4, where AR class must be named.
+## v0.0.1
+
+* Initial release.

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    remote_db (0.0.4)
+      activerecord (>= 3.0)
+      activesupport (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.2)
+    minitest (5.5.1)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.1)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  remote_db!
+  rspec
+  sqlite3

data/lib/remote_db/concerns/configurable.rb

@@ -3,6 +3,8 @@ module RemoteDb
     module Configurable
       extend ActiveSupport::Concern
 
+      class ForbiddenActionException < Exception; end
+
       module ClassMethods
         def configure(config_hash = nil)
           if config_hash
@@ -21,14 +23,32 @@ module RemoteDb
           @configuration ||= RemoteDb::Configuration.new
         end
 
-        def load_models!
-          define_base_record
+        def without_readonly
+          raise ForbiddenActionException unless configuration.environment == :test
+
+          load_models!(readonly: false)
+          yield
+          load_models!(readonly: true)
+        end
+
+        def load_models!(options = { readonly: true })
+          clear_old_models
+          define_base_record(options)
           send(:require_models) if respond_to?(:require_models)
         end
 
         private
+        
+        def clear_old_models
+          if self.const_defined? 'BaseRecord'
+            self.const_get('BaseRecord').clear_all_connections!
+          end
+          (self.constants - [:VERSION, :ClassMethods, :ForbiddenActionException]).each do |const|
+            self.send :remove_const, const
+          end
+        end
 
-        def define_base_record
+        def define_base_record(options)
           module_name = self.name
           connection_spec = configuration.connection_spec
           klass = Class.new(ActiveRecord::Base) do
@@ -41,7 +61,9 @@ module RemoteDb
             establish_connection(connection_spec)
 
             # Force model to be ready-only
-            include Concerns::ReadOnlyModel
+            if options[:readonly]
+              include Concerns::ReadOnlyModel
+            end
 
             # Scope which columns are exposed
             include Concerns::RestrictedColumns

data/lib/remote_db/concerns/restricted_columns.rb

@@ -6,17 +6,17 @@ module RemoteDb
       class ForbiddenColumnException < Exception; end
 
       included do
-        def read_attribute_with_safety(name)
+        def _read_attribute_with_safety(name)
           original_db_column = self.class.original_columns.include?(name.to_sym)
           visible_db_column  = self.class.visible_columns.include? (name.to_sym)
 
           if (original_db_column && visible_db_column) || !original_db_column
-            read_attribute_without_safety(name)
+            _read_attribute_without_safety(name)
           else
             raise ForbiddenColumnException, "Column #{name} is not allowed for access."
           end
         end
-        alias_method_chain :read_attribute, :safety
+        alias_method_chain :_read_attribute, :safety
       end
 
       module ClassMethods

data/lib/remote_db/configuration.rb

@@ -6,6 +6,7 @@ module RemoteDb
     attr_accessor :username
     attr_accessor :password
     attr_accessor :database
+    attr_accessor :environment
 
     def connection_spec
       {

data/lib/remote_db/version.rb

@@ -1,3 +1,3 @@
 module RemoteDb
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/remote_db.gemspec

@@ -16,4 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'activesupport', '>= 3.0'
   spec.add_runtime_dependency 'activerecord' , '>= 3.0'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
 end

data/spec/concerns/configurable_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+require 'test_db/test_db'
+
+describe RemoteDb do
+  let(:connection_spec) do
+    {
+      'adapter' => 'sqlite3',
+      'database' => 'test_database.sqlite3',
+      'pool' => 250,
+      'username' => 'root',
+      'password' => 'password',
+      'host' => '127.0.0.1'
+    }
+  end
+
+  describe 'configuring the gem' do
+    it 'should allow to set and read database settings' do
+      expect(TestDb.configuration.adapter).to be_nil
+      expect(TestDb.configuration.pool).to be_nil
+      expect(TestDb.configuration.host).to be_nil
+      expect(TestDb.configuration.username).to be_nil
+      expect(TestDb.configuration.password).to be_nil
+      expect(TestDb.configuration.database).to be_nil
+
+      TestDb.configure(connection_spec)
+
+      expect(TestDb.configuration.adapter).to  eq(connection_spec['adapter'])
+      expect(TestDb.configuration.pool).to  eq(connection_spec['pool'])
+      expect(TestDb.configuration.host).to eq(connection_spec['host'])
+      expect(TestDb.configuration.username).to eq(connection_spec['username'])
+      expect(TestDb.configuration.password).to eq(connection_spec['password'])
+      expect(TestDb.configuration.database).to eq(connection_spec['database'])
+    end
+
+    it 'should allow retrieve connection specifications' do
+      TestDb.configure(connection_spec)
+      expect(TestDb.configuration.connection_spec).to eq({
+            adapter:  connection_spec['adapter'],
+            pool:     connection_spec['pool'],
+            host:     connection_spec['host'],
+            username: connection_spec['username'],
+            password: connection_spec['password'],
+            database: connection_spec['database']
+          })
+    end
+  end
+
+  describe 'Loading models when the database settings are not valid' do
+    before do
+      TestDb.configure({adapter: nil, host: nil, username: nil, password: nil, database: nil})
+    end
+
+    it 'should throw an exception, and not load models' do
+      expect {
+        TestDb.load_models!
+      }.to raise_error
+    end
+  end
+
+  describe 'Loading models when the database settings are valid' do
+    before do
+      TestDb.configure(connection_spec)
+      TestDb.prepare_test_db!
+    end
+
+    after do
+      TestDb.cleanup_test_db!
+    end
+
+    it 'should not throw any exceptions, and load models' do
+      expect(TestDb.constants.include? :Person).to be_falsey
+      TestDb.load_models!
+      expect(TestDb.constants.include? :Person).to be_truthy
+    end
+
+    context 'when the models are loaded' do
+      before do
+        TestDb.load_models!
+      end
+
+      it 'should allow querying models' do
+        expect(TestDb::Person.count).to eq(1)
+        person = TestDb::Person.first
+
+        expect(person.id).to eq(1)
+        expect(person.first_name).to eq('John')
+      end
+
+      it 'should not allow creating or updating new models' do
+        person = TestDb::Person.first
+        person.first_name = 'Bob'
+
+        expect {
+          person.save
+        }.to raise_error(ActiveRecord::ReadOnlyRecord)
+
+        expect {
+          person.destroy
+        }.to raise_error(ActiveRecord::ReadOnlyRecord)
+
+        expect {
+          TestDb::Person.create(first_name: 'Bob')
+        }.to raise_error(ActiveRecord::ReadOnlyRecord)
+
+        expect {
+          TestDb::Person.destroy_all
+        }.to raise_error(ActiveRecord::ReadOnlyRecord)
+      end
+
+      it 'should not allow accessing hidden columns' do
+        person = TestDb::Person.first
+        expect {
+          puts person.last_name
+        }.to raise_error(RemoteDb::Concerns::RestrictedColumns::ForbiddenColumnException)
+
+        expect {
+          puts person[:last_name]
+        }.to raise_error(RemoteDb::Concerns::RestrictedColumns::ForbiddenColumnException)
+      end
+
+      context '#without_readonly' do
+        context 'when not specifying a environment' do
+          it 'should raise an error' do
+            expect {
+              TestDb.without_readonly do
+                TestDb::Person.create(first_name: 'Bob')
+              end
+            }.to raise_error(RemoteDb::Concerns::Configurable::ForbiddenActionException)
+          end
+        end
+
+        context 'when not specifying a test environment' do
+          before do
+            TestDb.configuration.environment = :development
+          end
+
+          it 'should raise an error' do
+            expect {
+              TestDb.without_readonly do
+                TestDb::Person.create(first_name: 'Bob')
+              end
+            }.to raise_error(RemoteDb::Concerns::Configurable::ForbiddenActionException)
+          end
+        end
+
+        context 'when using a test environment' do
+          before do
+            TestDb.configuration.environment = :test
+          end
+
+          it 'should not raise an error' do
+            expect(TestDb::Person.count).to eq(1)
+            TestDb.without_readonly do
+              TestDb::Person.create(first_name: 'Bob')
+            end
+            expect(TestDb::Person.count).to eq(2)
+            expect(TestDb::Person.first.first_name).to eq('John')
+            expect(TestDb::Person.last.first_name).to eq('Bob')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/test_db/person.rb

@@ -0,0 +1,6 @@
+module TestDb
+  class Person < BaseRecord
+    self.table_name = 'persons'
+    self.table_columns = [:id, :first_name]
+  end
+end

data/spec/test_db/test_db.rb

@@ -0,0 +1,25 @@
+require 'sqlite3'
+
+require 'remote_db'
+
+module TestDb
+  include RemoteDb::Concerns::Configurable
+
+  def self.require_models
+    load File.join([File.dirname(__FILE__), 'person.rb'])
+  end
+
+  def self.prepare_test_db!
+    db_file = configuration.database
+    db = SQLite3::Database.new db_file
+    db.execute 'CREATE TABLE IF NOT EXISTS persons (id INTEGER PRIMARY KEY, first_name TEXT, last_name TEXT)'
+    db.execute "INSERT INTO persons(id, first_name, last_name) VALUES (1, 'John', 'Smith')"
+  end
+
+  def self.cleanup_test_db!
+    db_file = configuration.database
+    if db_file && File.exists?(db_file)
+      File.unlink(db_file)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remote_db
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Omar Skalli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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'
 description: ''
 email:
 - omar@zenpayroll.com
@@ -46,8 +74,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - README.md
 - lib/remote_db.rb
 - lib/remote_db/concerns/configurable.rb
@@ -56,6 +86,10 @@ files:
 - lib/remote_db/configuration.rb
 - lib/remote_db/version.rb
 - remote_db.gemspec
+- spec/concerns/configurable_spec.rb
+- spec/spec_helper.rb
+- spec/test_db/person.rb
+- spec/test_db/test_db.rb
 homepage: https://github.com/ZenPayroll/remote_db
 licenses: []
 metadata: {}