update_cardinals_by 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4c004461c19b5e0aefe58e948cfb03811159e6b
-  data.tar.gz: cba4dafca4758e506b028221e8d54f7df3cf1643
+SHA256:
+  metadata.gz: 0f0c9aa2f3667c4925560e59e838b79a294b918f48dda0f7092b01e476ad0c40
+  data.tar.gz: cdd625ca542d8d09e7d4ac17a03e48862f569d42a1694bfb94751780b4ed37c0
 SHA512:
-  metadata.gz: f1d5c44273f2949c2406615f227df62eb212ee7f9ba4abbaaf66e189d21f28502da60e656b47542c7187caad5ce1627eec565f70d29dd8ab37c1d147b6fabdd7
-  data.tar.gz: fcb907362971985e948276a6fd10d4081850acc69e538c81e09170c4c34a6c17c7b2863bfb49ec68163db290115cbb90ee27b5d18c087393101a56ba4f633b40
+  metadata.gz: 6ff4b4a4137503a08368116b1b0f213bb41fe08a0d3ca06c8ba44694ca3d00d62e0ee54072efb418737b15af9f987022e9427a0a418e498f2816c5692b83e258
+  data.tar.gz: 382d155ff8ddc7b3aae7bc9936ee6d6186ac1f55e27dc444249fb23fda69c52c7cf0aa6c28f4c5fed2ae762cc29d6dc85b9faee7f4d704b08b537b2c28cbcd4f

data/README.md

@@ -1,22 +1,49 @@
-# Update Cardinals
+# Update Cardinals By delta for Postgresql.
+
+## Function
 
 A gem to more safely update cardinal numbers like credits.
 
-It will start a transaction, make the change with a delta and call the given block. If any exceptions are thrown in the block, the change will be reverted.
+It will
+* start a transaction
+* make the change with a delta `attr = attr + #{attributes[attr]}}`
+* call the given block with an indifferent hash of the latest values in the db.
+* update the given attributes on the instance to the latest values.
+* end transaction.
+
+If any exceptions are thrown in the block, the change will automatically be reverted.
 
-Sql will be like
+Sql will be like:
 
 ```sql
-  update accounts set credits = credit + -20 where id = 6
+  update accounts set credits = credit + -20 where id = 6 returning credits
 ```
 
+## Usage:
 
-Usage:
+```Gemfile
+gem 'update_cardinals_by', '~> 0.1.0'
+```
 
 ```ruby
-change_counters_by!(credits: -20) do |res|
+update_cardinals_by!(credits: -20) do |res|
   fail 'not enough credits' if res[:credits] < 0
   CreateWantedItems.run(..)
-  CreditMutation.create(credits_new: res[:credits], credits_change: -20)
+  CreditMutation.create credits_new: res[:credits],
+                        credits_old: credits,
+                        credits_change: -20
 end
 ```
+
+## Changelog
+
+0.1.0 changed activerecord support from 4.2 to 5.0 and 5.1
+
+## Developing
+
+```
+rake setup
+rake db:setup
+bundle exec appraisal install
+bundle exec appraisal rspec
+```

data/Rakefile

@@ -48,14 +48,16 @@ namespace :db do
   end
 
   task :drop => :load_db_settings do
-    %x{ dropdb #{ENV['DATABASE_NAME']} }
+    %x{ dropdb #{ENV['DATABASE_NAME']} --if-exists }
+    puts 'Database dropped'
   end
 
   task :create => :load_db_settings do
     %x{ createdb #{ENV['DATABASE_NAME']} }
+    puts 'Database created'
   end
 
-  task :migrate => :load_db_settings do
+  task :setup => [:drop, :create] do
     ActiveRecord::Base.establish_connection
 
     ActiveRecord::Base.connection.enable_extension 'hstore'
@@ -65,6 +67,6 @@ namespace :db do
       t.decimal  "money"
     end
 
-    puts 'Database migrated'
+    puts 'Database tables created'
   end
 end

data/lib/update_cardinals_by/version.rb

@@ -1,3 +1,3 @@
 module UpdateCardinalsBy
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/update_cardinals_by.rb

@@ -3,12 +3,15 @@ require 'active_support/concern'
 module UpdateCardinalsBy
   extend ActiveSupport::Concern
 
-  # 
-  # returns indifferent hash of new values.
+  # Changes given attributes by delta.
+  # @param attributes, hash from attribute to delta
+  # @param &block Block to execute after making update.
+  #               Will receive indifferent hash from attribute to latest value in db.
+  # @returns indifferent hash from attribute to latest value in db.
   def update_cardinals_by!(attributes, &block)
     db_attributes = attributes.map { |k, v| [self.class.connection.quote_column_name(k), v] }
     updates = db_attributes.map.with_index { |(k, v), i| "#{k} = #{k} + $#{i+1}" }
-    binds = db_attributes.map { |k, v| [column_for_attribute(k), v] }
+    binds = attributes.map { |k, v| [column_for_attribute(k), v] }
 
     transaction do
       res = self.class.connection.exec_query(
@@ -18,7 +21,7 @@ module UpdateCardinalsBy
         "returning #{db_attributes.map(&:first).join(', ')}",
         'SQL', binds
       ).first
-       .map { |k, v| [k, column_for_attribute(k).type_cast_from_database(v)] }
+       .map { |k, v| [k, type_for_attribute(k).cast(v)] }
       res = HashWithIndifferentAccess[ res ]
 
       yield res if block_given?

data/spec/concerns/update_cardinals_by_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+class Account < ActiveRecord::Base
+  include UpdateCardinalsBy
+
+  def update_by!(attributes)
+    update_cardinals_by!(attributes) do |res|
+      if res[:credits] && res[:credits] < 0
+        fail 'Credits dropped below 0'
+      end
+    end
+  rescue => e
+    e
+  end
+end
+
+describe UpdateCardinalsBy do
+  let(:account) { Account.create credits: 100, money: BigDecimal(12, 34) }
+
+  describe 'update_cardinals_by!' do
+    it 'accepts positive change' do
+      account.update_by!(credits: 20, money: BigDecimal(3, 16))
+      expect(account.credits).to eq 120
+      expect(account.money).to eq BigDecimal(15, 50)
+    end
+
+    it 'accepts negative change' do
+      account.update_by!(credits: -20, money: -BigDecimal(1, 24))
+      expect(account.credits).to eq 80
+      expect(account.money).to eq BigDecimal(11, 10)
+    end
+
+    it 'leaves leaves the instance in a saved state' do
+      account.update_by!(credits: 20, money: BigDecimal(3, 16))
+      expect(account.changed?).to be_falsy
+    end
+
+    it 'reverts the value when the block throws an error' do
+      account.update_by!(credits: -200)
+      expect(account.credits).to eq 100
+      expect(account.reload.credits).to eq 100
+    end
+
+    it 'passes the right types to the block' do
+      account.update_cardinals_by!(credits: 20, money: BigDecimal(3, 16)) do |res|
+        expect(res[:credits]).to be_a Integer
+        expect(res[:money]).to be_a BigDecimal
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'active_record'
+Bundler.require(:default, :development)
+
+require 'update_cardinals_by'
+
+Dotenv.load
+
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: update_cardinals_by
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Hampei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.2.7
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.2.7
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -56,32 +62,46 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -106,6 +126,8 @@ files:
 - Rakefile
 - lib/update_cardinals_by.rb
 - lib/update_cardinals_by/version.rb
+- spec/concerns/update_cardinals_by_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/hampei/update_cardinals_by
 licenses:
 - MIT
@@ -118,17 +140,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: postgres database extension to increment/decrement values safely and get
   back result.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/concerns/update_cardinals_by_spec.rb