switch_point 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f01102cca54c7b028bddcf7663ae5ec5de4fd28
-  data.tar.gz: 0b2d26c5a70f7dbe7341f6b7a81ebed58219bf2d
+  metadata.gz: 3044b7a1ae2a9a6e022a82440cfaeaaabe90da64
+  data.tar.gz: 7640bd6b1a38e93f84f54c2980d32848fa2260da
 SHA512:
-  metadata.gz: e293b56dd3daa2873beb81602d02ee2959597c5a8d73a7e986ad4d274074e9bff0955919ccd417235e30ed5a688c33b08c1a0df1b1c09fe0ce292d4de594da20
-  data.tar.gz: a4bab4cf2b8c799310880756afae5a55505aaaccd9a2a56c512afde07786954326fa44c35243614b68d96d0a42fdcbe86cca5a068e3657400044b215806d78c6
+  metadata.gz: 641b875847d36f8878eb954d0a950384d770ecc4b779c36ddfd5d741c94f103c1d0422a823c8b03a1c2f610c540c8bf2aedbac9bfa423f119b0e7159c081d20d
+  data.tar.gz: 78da2c2d465bd5660946c7b74bf1ad23c00ca2deae3af478737dcbad716316bf4d2ffccd2333359816ae81d2bb8e1c996bcc54e91f3c0e1adfd04cdf918437e1

data/.rubocop.yml

@@ -0,0 +1,36 @@
+inherit_from: .rubocop_todo.yml
+
+Style/AlignParameters:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - Rakefile
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SignalException:
+  Enabled: false
+
+Style/TrailingComma:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.7.0 (2015-10-16)
+- `Model.with_readonly` and `Model.with_writable` now raises error when the Model doesn't use switch_point
+
 ## 0.6.0 (2015-04-14)
 - Add `SwitchPoint::QueryCache` middleware
 - `Model.cache` and `Model.uncached` is now hooked by switch_point

data/Rakefile

@@ -1,10 +1,13 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
-task :default => :spec
+task :default => [:spec, :rubocop]
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
 desc 'Run benchmark'
 task :benchmark do
   sh 'ruby', 'benchmark/proxy.rb'

data/benchmark/proxy.rb

@@ -8,7 +8,6 @@ SwitchPoint.configure do |config|
     writable: :proxy_writable
 end
 
-
 class Plain < ActiveRecord::Base
 end
 

data/lib/switch_point/config.rb

@@ -1,5 +1,8 @@
 module SwitchPoint
   class Config
+    attr_accessor :auto_writable
+    alias_method :auto_writable?, :auto_writable
+
     def initialize
       self.auto_writable = false
     end
@@ -9,14 +12,6 @@ module SwitchPoint
       switch_points[name] = config
     end
 
-    def auto_writable=(val)
-      @auto_writable = val
-    end
-
-    def auto_writable?
-      @auto_writable
-    end
-
     def switch_points
       @switch_points ||= {}
     end
@@ -28,8 +23,6 @@ module SwitchPoint
     def model_name(name, mode)
       if fetch(name)[mode]
         "#{name}_#{mode}".camelize
-      else
-        nil
       end
     end
 
@@ -44,15 +37,15 @@ module SwitchPoint
     private
 
     def assert_valid_config!(config)
-      unless config.has_key?(:readonly) || config.has_key?(:writable)
+      unless config.key?(:readonly) || config.key?(:writable)
         raise ArgumentError.new(':readonly or :writable must be specified')
       end
-      if config.has_key?(:readonly)
+      if config.key?(:readonly)
         unless config[:readonly].is_a?(Symbol)
           raise TypeError.new(":readonly's value must be Symbol")
         end
       end
-      if config.has_key?(:writable)
+      if config.key?(:writable)
         unless config[:writable].is_a?(Symbol)
           raise TypeError.new(":writable's value must be Symbol")
         end

data/lib/switch_point/connection.rb

@@ -1,3 +1,4 @@
+require 'switch_point/error'
 require 'switch_point/proxy_repository'
 
 module SwitchPoint
@@ -8,7 +9,7 @@ module SwitchPoint
     DESTRUCTIVE_METHODS.each do |method_name|
       define_method(:"#{method_name}_with_switch_point") do |*args, &block|
         parent_method = :"#{method_name}_without_switch_point"
-        if self.pool.equal?(ActiveRecord::Base.connection_pool)
+        if pool.equal?(ActiveRecord::Base.connection_pool)
           Connection.handle_base_connection(self, parent_method, *args, &block)
         else
           Connection.handle_generated_connection(self, parent_method, method_name, *args, &block)
@@ -16,16 +17,13 @@ module SwitchPoint
       end
     end
 
-    class ReadonlyError < StandardError
-    end
-
     def self.handle_base_connection(conn, parent_method, *args, &block)
       switch_points = conn.pool.spec.config[:switch_points]
       if switch_points
         switch_points.each do |switch_point|
           proxy = ProxyRepository.find(switch_point[:name])
           if switch_point[:mode] != :writable
-            raise RuntimeError.new("ActiveRecord::Base's switch_points must be writable, but #{switch_point[:name]} is #{switch_point[:mode]}")
+            raise Error.new("ActiveRecord::Base's switch_points must be writable, but #{switch_point[:name]} is #{switch_point[:mode]}")
           end
           purge_readonly_query_cache(proxy)
         end
@@ -48,7 +46,7 @@ module SwitchPoint
           purge_readonly_query_cache(proxy)
           conn.send(parent_method, *args, &block)
         else
-          raise RuntimeError.new("Unknown mode #{switch_point[:mode]} is given with #{name}")
+          raise Error.new("Unknown mode #{switch_point[:mode]} is given with #{name}")
         end
       else
         conn.send(parent_method, *args, &block)

data/lib/switch_point/error.rb

@@ -0,0 +1,10 @@
+module SwitchPoint
+  class Error < StandardError
+  end
+
+  class ReadonlyError < Error
+  end
+
+  class UnconfiguredError < Error
+  end
+end

data/lib/switch_point/model.rb

@@ -1,3 +1,4 @@
+require 'switch_point/error'
 require 'switch_point/proxy_repository'
 
 module SwitchPoint
@@ -40,7 +41,7 @@ module SwitchPoint
         if switch_point_proxy
           switch_point_proxy.with_readonly(&block)
         else
-          block.call
+          raise UnconfiguredError.new("#{name} isn't configured to use switch_point")
         end
       end
 
@@ -48,7 +49,7 @@ module SwitchPoint
         if switch_point_proxy
           switch_point_proxy.with_writable(&block)
         else
-          block.call
+          raise UnconfiguredError.new("#{name} isn't configured to use switch_point")
         end
       end
 
@@ -69,11 +70,11 @@ module SwitchPoint
 
       def transaction_with(*models, &block)
         unless can_transaction_with?(*models)
-          raise RuntimeError.new("switch_point's model names must be consistent")
+          raise Error.new("switch_point's model names must be consistent")
         end
 
         with_writable do
-          self.transaction(&block)
+          transaction(&block)
         end
       end
 
@@ -90,8 +91,6 @@ module SwitchPoint
               model.instance_variable_get(:@switch_point_name),
               :writable
             )
-          else
-            nil
           end
         end
 

data/lib/switch_point/proxy.rb

@@ -1,3 +1,5 @@
+require 'switch_point/error'
+
 module SwitchPoint
   class Proxy
     attr_reader :initial_name
@@ -34,12 +36,12 @@ module SwitchPoint
       switch_point = { name: name, mode: mode }
       if pool.equal?(ActiveRecord::Base.connection_pool)
         if mode != :writable
-          raise RuntimeError.new("ActiveRecord::Base's switch_points must be writable, but #{name} is #{mode}")
+          raise Error.new("ActiveRecord::Base's switch_points must be writable, but #{name} is #{mode}")
         end
         switch_points = pool.spec.config[:switch_points] || []
         switch_points << switch_point
         pool.spec.config[:switch_points] = switch_points
-      elsif pool.spec.config.has_key?(:switch_point)
+      elsif pool.spec.config.key?(:switch_point)
         # Only :writable is specified
       else
         pool.spec.config[:switch_point] = switch_point
@@ -95,7 +97,7 @@ module SwitchPoint
       unless AVAILABLE_MODES.include?(new_mode)
         raise ArgumentError.new("Unknown mode: #{new_mode}")
       end
-      saved_mode = self.thread_local_mode
+      saved_mode = thread_local_mode
       self.thread_local_mode = new_mode
       block.call
     ensure

data/lib/switch_point/version.rb

@@ -1,3 +1,3 @@
 module SwitchPoint
-  VERSION = "0.6.0"
+  VERSION = '0.7.0'
 end

data/spec/spec_helper.rb

@@ -57,8 +57,8 @@ RSpec.configure do |config|
   end
 
   config.after(:suite) do
-    ActiveRecord::Base.configurations.each_value do |config|
-      FileUtils.rm_f(config[:database])
+    ActiveRecord::Base.configurations.each_value do |c|
+      FileUtils.rm_f(c[:database])
     end
   end
 

data/spec/switch_point/model_spec.rb

@@ -33,8 +33,8 @@ RSpec.describe SwitchPoint::Model do
 
     context 'when auto_writable is disabled' do
       it 'raises error when destructive query is requested in readonly mode' do
-        expect { Book.create }.to raise_error(SwitchPoint::Connection::ReadonlyError)
-        expect { Book.with_readonly { Book.create } }.to raise_error(SwitchPoint::Connection::ReadonlyError)
+        expect { Book.create }.to raise_error(SwitchPoint::ReadonlyError)
+        expect { Book.with_readonly { Book.create } }.to raise_error(SwitchPoint::ReadonlyError)
         expect { Book.with_writable { Book.create } }.to_not raise_error
       end
     end
@@ -217,7 +217,7 @@ RSpec.describe SwitchPoint::Model do
             expect(Book.connection.query_cache.size).to eq(1)
             Book.with_writable do
               Book.create
-              FileUtils.cp('main_writable.sqlite3', 'main_readonly.sqlite3')  # XXX: emulate replication
+              FileUtils.cp('main_writable.sqlite3', 'main_readonly.sqlite3') # XXX: emulate replication
             end
             expect(Book.connection.query_cache.size).to eq(0)
             expect(Book.count).to eq(1)
@@ -227,8 +227,8 @@ RSpec.describe SwitchPoint::Model do
     end
 
     context 'without use_switch_point' do
-      it 'bypasses given block' do
-        expect(Note.with_writable { :bypass }).to eq(:bypass)
+      it 'raises error' do
+        expect { Note.with_writable { :bypass } }.to raise_error(SwitchPoint::UnconfiguredError)
       end
     end
 
@@ -263,7 +263,7 @@ RSpec.describe SwitchPoint::Model do
 
   describe '#with_mode' do
     it 'raises error if unknown mode is given' do
-      expect { SwitchPoint::ProxyRepository.checkout(:main).with_mode(:typo) }.to raise_error
+      expect { SwitchPoint::ProxyRepository.checkout(:main).with_mode(:typo) }.to raise_error(ArgumentError)
     end
   end
 
@@ -291,14 +291,14 @@ RSpec.describe SwitchPoint::Model do
   end
 
   describe '.transaction_with' do
-    context "when each model has a same writable" do
+    context 'when each model has a same writable' do
       before do
         @before_book_count  = Book.count
         @before_book2_count = Book2.count
 
         Book.transaction_with(Book2) do
-          new_book  = Book.create
-          new_book2 = Book2.create
+          Book.create
+          Book2.create
         end
 
         @after_book_count = Book.with_writable do
@@ -324,25 +324,25 @@ RSpec.describe SwitchPoint::Model do
       end
     end
 
-    context "when each model has a other writable" do
+    context 'when each model has a other writable' do
       it {
         expect {
           Book.transaction_with(Book3) do
-            new_book  = Book.create
-            new_book3 = Book3.create
+            Book.create
+            Book3.create
           end
-        }.to raise_error RuntimeError
+        }.to raise_error(SwitchPoint::Error)
       }
     end
 
-    context "when raise exception in transaction that include some model, and models each have other writable" do
+    context 'when raise exception in transaction that include some model, and models each have other writable' do
       before do
         @before_book_count  = Book.count
         @before_book3_count = Book3.count
 
         Book.transaction_with(Book2) do
-          new_book  = Book.create
-          new_book3 = Book3.with_writable do
+          Book.create
+          Book3.with_writable do
             Book3.create
           end
           raise ActiveRecord::Rollback
@@ -366,7 +366,7 @@ RSpec.describe SwitchPoint::Model do
       end
     end
 
-    context "when nested transaction_with then parent transaction rollbacked" do
+    context 'when nested transaction_with then parent transaction rollbacked' do
       before do
         @before_book_count  = Book.count
         @before_book3_count = Book3.count

data/spec/switch_point/query_cache_spec.rb

@@ -7,7 +7,7 @@ class TestApp
     [Nanika1, Nanika2].each do |model|
       r = model.with_readonly { model.connection.query_cache_enabled }
       w = model.with_writable { model.connection.query_cache_enabled }
-      state[model.name] = { readonly: r, writable: r }
+      state[model.name] = { readonly: r, writable: w }
     end
     env[:state] = state
     :result
@@ -45,7 +45,7 @@ RSpec.describe SwitchPoint::QueryCache do
         expect(app.call(env)).to eq(:result)
         expect(env[:state]).to eq(
           'Nanika1' => { readonly: true, writable: true },
-          'Nanika2' => { readonly: false, writable: false },
+          'Nanika2' => { readonly: false, writable: true },
         )
       end
     end

data/switch_point.gemspec

@@ -4,27 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'switch_point/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "switch_point"
+  spec.name          = 'switch_point'
   spec.version       = SwitchPoint::VERSION
-  spec.authors       = ["Kohei Suzuki"]
-  spec.email         = ["eagletmt@gmail.com"]
-  spec.summary       = %q{Switching database connection between readonly one and writable one.}
-  spec.description   = %q{Switching database connection between readonly one and writable one.}
-  spec.homepage      = "https://github.com/eagletmt/switch_point"
-  spec.license       = "MIT"
+  spec.authors       = ['Kohei Suzuki']
+  spec.email         = ['eagletmt@gmail.com']
+  spec.summary       = 'Switching database connection between readonly one and writable one.'
+  spec.description   = 'Switching database connection between readonly one and writable one.'
+  spec.homepage      = 'https://github.com/eagletmt/switch_point'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   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.require_paths = ['lib']
 
-  spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "benchmark-ips"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "rack"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", ">= 3.0"
-  spec.add_development_dependency "sqlite3"
-  spec.add_dependency "activerecord", ">= 3.2.0"
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_dependency 'activerecord', '>= 3.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: switch_point
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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
@@ -145,6 +159,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
@@ -162,6 +178,7 @@ files:
 - lib/switch_point.rb
 - lib/switch_point/config.rb
 - lib/switch_point/connection.rb
+- lib/switch_point/error.rb
 - lib/switch_point/model.rb
 - lib/switch_point/proxy.rb
 - lib/switch_point/proxy_repository.rb
@@ -193,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Switching database connection between readonly one and writable one.