bitcoin_reward_era 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16608263e0df7b5b6ec7bc9935aedde97fe0dd3c
-  data.tar.gz: eef312efde3b543cbf76b829e08d64882f439043
+  metadata.gz: c1f73829b4afd9b52f56b93e78605af2df905510
+  data.tar.gz: ad12bf9921581b06e81f943ca4a4ad1b9419b4ea
 SHA512:
-  metadata.gz: f1f79db458e33370135bcaa07779784af19d6cca7cfdf5639e6c676c625a1f22061682ee26e67b234a2aed21669ee2a8878d6c7a645d43a3c77071e6f75d998a
-  data.tar.gz: 6fe32ac7ef5bebb96e270e95faa844ded44eecd6366275e66d2a52ba646d0186ea15c3668190b707a021c4ef85234d0c7062f6b2834981ee9313ff88b3fcb5fe
+  metadata.gz: db3fee494ac3a35aa3e524ad8d5fe4e142465b3e46473d526dbea19a48bf2ed7d2fd2ddb587769fe5c9355d3e1176b8546b58710a6ea9adbddb6169dc3e37da2
+  data.tar.gz: f3b6d46f2bbe24487345179c0186d81b9d895de4d566bb1c6b9a31241add6faf1a781d542ec3baac11a5a46c8a4dc6ae91b73470fef3678fcd253c000facd794

data/.rubocop.yml

@@ -16,5 +16,5 @@ Style/Documentation:
 Style/MethodDefParentheses:
   EnforcedStyle: require_no_parentheses
 
-Style/RegexpLiteral:
-  MaxSlashes: 0
+Style/SpaceAroundOperators:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bitcoin_reward_era (0.0.1)
+    bitcoin_reward_era (0.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -9,6 +9,7 @@ GEM
     ast (2.0.0)
     astrolabe (1.3.0)
       parser (>= 2.2.0.pre.3, < 3.0)
+    awesome_print (1.6.1)
     diff-lcs (1.2.5)
     minitest (5.5.1)
     parser (2.2.0.3)
@@ -23,7 +24,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
-    rubocop (0.29.1)
+    rubocop (0.30.0)
       astrolabe (~> 1.3)
       parser (>= 2.2.0.1, < 3.0)
       powerpack (~> 0.1)
@@ -35,9 +36,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print (~> 1.6)
   bitcoin_reward_era!
   bundler (~> 1.8)
-  minitest (~> 5.5.1)
+  minitest (~> 5.5, >= 5.5.1)
   rake (~> 10)
   rspec-expectations (~> 3.2)
   rspec-mocks (~> 3.2)

data/README.md

@@ -1,6 +1,6 @@
 Gem representing Bitcoin reward eras.
 
-100% BigDecimal math (not Float or Fixnum).
+100% BigDecimal arithmetic.
 
 ```
 gem install 'bitcoin_reward_era'

data/bitcoin_reward_era.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Bitcoin reward era gem'
 
   spec.description   = "Bitcoin reward era gem.\n" \
-                       '100% BigDecimal math (not Float or Fixnum).'
+                       '100% BigDecimal arithmetic.'
 
   spec.homepage      = 'https://github.com/tmornini/bitcoin_reward_era'
   spec.license       = 'MIT'
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename f }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'awesome_print',      '~> 1.6'
   spec.add_development_dependency 'bundler',            '~> 1.8'
   spec.add_development_dependency 'rake',               '~> 10'
   spec.add_development_dependency 'minitest',           '~> 5.5', '>= 5.5.1'

data/lib/bitcoin_reward_era/amount.rb

@@ -0,0 +1,28 @@
+# -*- encoding : utf-8 -*-
+
+require 'delegate'
+require 'bigdecimal'
+
+module BitcoinRewardEra
+  class Amount < SimpleDelegator
+    def initialize amount
+      super(BigDecimal amount)
+    end
+
+    def inspect
+      to_s
+    end
+
+    def to_json _state_ = nil
+      %("#{self}")
+    end
+
+    def to_s pattern = 'F'
+      __getobj__.to_s pattern
+    end
+
+    def to_str
+      to_s
+    end
+  end
+end

data/lib/bitcoin_reward_era/calculator.rb

@@ -1,40 +1,40 @@
 # -*- encoding : utf-8 -*-
 
-require 'bigdecimal'
 require 'time'
 
+require 'bitcoin_reward_era/amount'
+
 module BitcoinRewardEra
   class Calculator
-    BLOCKS_PER_REWARD_ERA  = 210_000
-    SECONDS_PER_REWARD_ERA = BLOCKS_PER_REWARD_ERA * 10 * 60
+    BLOCKS_PER_REWARD_ERA  = Amount.new(210_000)
+    SECONDS_PER_REWARD_ERA = Amount.new(BLOCKS_PER_REWARD_ERA * 10 * 60)
     GENESIS_BLOCK_TIME     = Time.at(1_231_006_505).utc
 
     attr_reader :reward_era_number
 
     def initialize config
-      @representation_klass = config[:representation_klass] || Representation
-      @bigdecimal_klass     = config[:bigdecimal_klass]     || BigDecimal
       @time_klass           = config[:time_klass]           || Time
+      @amount_klass         = config[:amount_klass]         || Amount
 
-      @reward_era_number = config[:reward_era_number].to_i
+      @reward_era_number = @amount_klass.new config[:reward_era_number]
     end
 
-    def first_block_in_era
-      last_reward_era_number * BLOCKS_PER_REWARD_ERA
+    def first_block
+      Amount.new last_reward_era_number * BLOCKS_PER_REWARD_ERA
     end
 
     def btc_per_block
-      reward = BigDecimal 50
+      initial_reward = @amount_klass.new 50
 
-      truncate_at_satoshis reward / (2**last_reward_era_number)
+      truncate_at_satoshis initial_reward / (2**last_reward_era_number)
     end
 
     def year
-      beginning_of_reward_era.year + portion_of_year
+      Amount.new this_year + portion_of_year
     end
 
     def start_btc
-      btc_in_circulation = 0
+      btc_in_circulation = BigDecimal 0
 
       1.upto last_reward_era_number do |ren|
         btc_in_circulation +=
@@ -42,11 +42,11 @@ module BitcoinRewardEra
           .btc_per_block * BLOCKS_PER_REWARD_ERA
       end
 
-      btc_in_circulation
+      Amount.new btc_in_circulation
     end
 
     def btc_added
-      end_btc - start_btc
+      Amount.new end_btc - start_btc
     end
 
     def end_btc
@@ -54,41 +54,41 @@ module BitcoinRewardEra
     end
 
     def btc_increase_percentage
-      btc_added / last_calculator.end_btc
+      Amount.new btc_added / last_calculator.end_btc
     end
 
     def end_btc_percent_of_limit
-      end_btc / final_calculator.end_btc
+      Amount.new end_btc / final_calculator.end_btc
     end
 
     def supply_inflation_rate
-      ((1 + btc_increase_percentage)**0.25) - 1
+      Amount.new(((1 + btc_increase_percentage)**0.25) - 1)
     end
 
     private
 
+    def truncate_at_satoshis amount
+      string = amount.to_s '8F'
+
+      truncation_match = string.match(/^\d+[.]\d+/)
+
+      @amount_klass.new truncation_match[0]
+    end
+
     def last_reward_era_number
-      @reward_era_number - 1
+      Amount.new @reward_era_number - 1
     end
 
     def next_reward_era_number
-      @reward_era_number + 1
+      Amount.new @reward_era_number + 1
     end
 
     def final_reward_era_number
-      34
-    end
-
-    def truncate_at_satoshis btc
-      string = btc.to_s '8F'
-
-      truncation_match = string.match(/^\d+[.]\d+/)
-
-      BigDecimal truncation_match[0]
+      Amount.new 34
     end
 
     def seconds_since_block_zero
-      first_block_in_era * 60 * 10
+      Amount.new first_block * 60 * 10
     end
 
     def beginning_of_reward_era
@@ -96,28 +96,25 @@ module BitcoinRewardEra
     end
 
     def this_year
-      beginning_of_reward_era.year
+      Amount.new beginning_of_reward_era.year
     end
 
     def portion_of_year
       next_year = this_year + 1
 
-      beginning_of_this_year = Time.new(this_year, 1, 1, 0, 0, 0, '+00:00').utc
-      beginning_of_next_year = Time.new(next_year, 1, 1, 0, 0, 0, '+00:00').utc
+      beginning_of_this_year =
+        Time.new(this_year, 1, 1, 0, 0, 0, '+00:00').utc.to_i
+
+      beginning_of_next_year =
+        Time.new(next_year, 1, 1, 0, 0, 0, '+00:00').utc.to_i
 
-      portion_of_this_year =
-        (beginning_of_reward_era - beginning_of_this_year) /
-        (beginning_of_next_year - beginning_of_this_year)
+      bd_beginning_of_reward_era = BigDecimal beginning_of_reward_era.to_i
 
-      # ap beginning_of_this_year:    beginning_of_this_year,
-      #    beginning_of_this_year_i:  beginning_of_this_year.to_i,
-      #    beginning_of_reward_era:   beginning_of_reward_era,
-      #    beginning_of_reward_era_i: beginning_of_reward_era.to_i,
-      #    beginning_of_next_year:    beginning_of_next_year,
-      #    beginning_of_next_year_i:  beginning_of_next_year.to_i,
-      #    portion_of_this_year:      portion_of_this_year
+      bd_portion_of_year =
+        BigDecimal(bd_beginning_of_reward_era - beginning_of_this_year) /
+        BigDecimal(beginning_of_next_year - beginning_of_this_year)
 
-      portion_of_this_year
+      Amount.new bd_portion_of_year
     end
 
     def last_calculator

data/lib/bitcoin_reward_era/representation.rb

@@ -11,7 +11,7 @@ module BitcoinRewardEra
 
     def to_representation
       {
-        block:                    @calculator.first_block_in_era,
+        first_block:              @calculator.first_block,
         reward_era_number:        @calculator.reward_era_number,
         btc_per_block:            @calculator.btc_per_block,
         year:                     @calculator.year,
@@ -26,7 +26,7 @@ module BitcoinRewardEra
 
     def to_s
       [
-        format('%7d', @calculator.first_block_in_era),
+        format('%7d', @calculator.first_block),
         format('%10d', @calculator.reward_era_number),
         align(@calculator.btc_per_block, 2),
         align(@calculator.year, 4, 3),

data/lib/bitcoin_reward_era/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 
 module BitcoinRewardEra
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitcoin_reward_era
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tom Mornini
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +116,7 @@ dependencies:
         version: '0.29'
 description: |-
   Bitcoin reward era gem.
-  100% BigDecimal math (not Float or Fixnum).
+  100% BigDecimal arithmetic.
 email:
 - tom@subledger.com
 executables:
@@ -120,6 +134,7 @@ files:
 - bitcoin_reward_era.gemspec
 - exe/btc_money_supply
 - lib/bitcoin_reward_era.rb
+- lib/bitcoin_reward_era/amount.rb
 - lib/bitcoin_reward_era/calculator.rb
 - lib/bitcoin_reward_era/report.rb
 - lib/bitcoin_reward_era/representation.rb