capitalism-journal 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd16336c030df95231517a7ad05619832f965d7a
-  data.tar.gz: 2e61c3e0276685442583a38bda30a51180e77831
+  metadata.gz: 2d8a6189b3b070d632ed6e41e4416f3b5933bfed
+  data.tar.gz: 63ea751442ec6439ebc12b94884d9b8025bc5f05
 SHA512:
-  metadata.gz: '088f828ee192e34edc91679db2565162672085158298d1aeb05525e6c4c77ce8062ad63da707c98d083dd84a9303ae1b966fd433b63d9fd2d308b563e00ce9ea'
-  data.tar.gz: 4e93e75a962dc4bd19493e6340fd9fea15019ac8be301d9ccc634259062d3551bc4df0a6678d6a53e0eae580cd2748c40614161480d12fd0fa10796a88eb2d1f
+  metadata.gz: 1da677f33c229839146b32a65a1890d3cf6dd8d2f315e94b93780adbea4eee52cf0ffc8fb15dcc69a695e48ea08d86576d203062b1bee4f3a32dbde5afbb18cd
+  data.tar.gz: 3344720641522bdecc298c791587871256c404897010126d9590bfe3ad9d5fde207b333eb1a4f6dd9f601132a770a61b70aad41a553cde661c42504b320ea0d4

data/README.md

@@ -1,8 +1,8 @@
-# Capitalism Journal
+# capitalism-journal
 
 ## Track any event.
 
-Incident, payment, weight, sleep, mood, thought, etc.
+Payment, temperature, sleep, mood, thought, etc.
 
 ## Installation
 
@@ -20,24 +20,7 @@ Or install without bundler:
 
 ## Creating a journal
 
-Journal validates each event value either by class or a value.
-
-**Whitelisting class**
-
-Initialize journal with an allowed value class (TrueClass by default). 
-
     journal = Capitalism::Journal.new
-    => #<Capitalism::Journal:0x007fa1a39486e8 @whitelist=true, @events=[]>
-    
-    journal = Capitalism::Journal.new(Object)
-    => #<Capitalism::Journal:0x007fa1a5066348 @whitelist=Object, @events=[]>
-
-**Whitelisting values**
-
-Initialize journal with an array of whitelisted values.
-
-    journal = Capitalism::Journal.new([1, 2, 3])
-    => #<Capitalism::Journal:0x007fa6cf177af0 @whitelist=[1, 2, 3], @events=[]>
 
 ## Adding events
 
@@ -57,12 +40,22 @@ Helper methods:
     # journal.add(timestamp: timestamp, value: true)
     journal.add_timestamp(timestamp)
 
+## Validating events
+
+By default journal accepts events with arbitrary timestamps and values.
+
+For a custom validation inject a class that responds to `#call.(journal, event)`:
+
+    event_validator = -> (_journal, _event) { false }
+    journal = Capitalism::Journal.new(event_validator)
+    journal.add
+    => Capitalism::Journal::InvalidEvent
 
 ## Reading events
 
 Journal stores and returns events in the order they were added.
 
-You can think of `Journal#add` as an alias for `Array.push`.
+Think of `Journal#add` as an alias for `Array.push`.
 
 Getting events with timestamps and values:
 
@@ -71,8 +64,8 @@ Getting events with timestamps and values:
     journal.add_timestamp((DateTime.now - 3).to_time)    
     journal.events
     => [
-        #<Capitalism::Journal::Event timestamp=2017-10-22 21:13:14 +0300 value=true>, 
-        #<Capitalism::Journal::Event timestamp=2017-10-19 21:13:17 +0300 value=true>
+        #<OpenStruct timestamp=2017-10-22 21:13:14 +0300 value=true>, 
+        #<OpenStruct timestamp=2017-10-19 21:13:17 +0300 value=true>
     ]
     puts journal.events.map(&:to_h)
     => {:timestamp=>2017-10-22 21:13:14 +0300, :value=>true}
@@ -95,64 +88,38 @@ Values only:
 
 ## Usage examples
 
-### Occurrence
+### TrueClass
 
-    lightning = Capitalism::Journal.new
-    lightning.add
-    # next day
     lightning.add
-    lightning.timestamps
-    => [2017-10-22 21:16:53 +0300, 2017-10-23 21:16:57 +0300]
 
-### Presence
+### Boolean
 
-    target_hit = Capitalism::Journal.new([true, false])
-    target_hit.add_value(true)
     target_hit.add_value(false)
 
 ### Integer
 
-    pushups = Capitalism::Journal.new(Integer)
-    pushups.add_value(10)
     pushups.add_value(18)
 
 ### Float
 
-    temperature = Capitalism::Journal.new(Float)
     temperature.add_value(36.6)
-    temperature.add_value(37.2)
 
 ### Decimal
 
-    currency_exchange_rate = Capitalism::Journal.new(BigDecimal)
     currency_exchange_rate.add_value 2.0001.to_d    
-    puts currency_exchange_rate.last.value.to_f
-    => 2.0001
 
 ### Duration
 
-    formula_one_lap_time = Capitalism::Journal.new(Capitalism::Journal::Event::Duration)
     formula_one_lap_time.add_value 84125 # in milliseconds
-    seconds = formula_one_lap_time.events.last.value.to_f / 1000
-    puts Time.at(seconds).strftime("%M:%S.%L")
-    => 01:24.125 # 1 minute, 24 seconds, 125 milliseconds 
 
 ### String
 
-    diary = Capitalism::Journal.new(String)
     diary.add_value('Released Journal gem.')
 
-### Choice
+### Symbol
 
-    coin_flip = Capitalism::Journal.new([:heads, :tails])
     coin_flip.add_value(:heads)
-    coin_flip.add_value(:tails)
 
 ### Hash
 
-    contact_form = Capitalism::Journal.new(Hash)
     contact_form.add(value: { from: 'andrey@zharikov.pro', message: 'Good news!' })
-    puts contact_form.events.last.timestamp
-    => 2017-10-22 21:09:54 +0300
-    puts contact_form.events.last.value
-    => {:from=>"andrey@zharikov.pro", :message=>"Good news!"}

data/capitalism-journal.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['andrey@zharikov.pro']
 
   spec.summary       = 'Track any event'
-  spec.description   = 'Incident, weight, sleep, mood, thought, etc.'
+  spec.description   = 'Payment, temperature, sleep, mood, thought, etc.'
   spec.homepage      = 'https://github.com/zharikovpro/capitalism-journal'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -20,8 +20,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'dry-struct', '~> 0.3'
-
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/capitalism/journal.rb

@@ -1,32 +1,20 @@
-require_relative 'journal/version'
-require_relative 'journal/event'
+require 'ostruct'
 
 module Capitalism
   class Journal
-    class ValueClassMismatch < StandardError
+    class InvalidEvent < StandardError
     end
 
-    class EmptyWhitelist < StandardError
-    end
-
-    class ValueIsNotWhitelisted < StandardError
-    end
+    attr_reader :event_validator, :events
 
-    attr_reader :whitelist
-
-    def initialize(whitelist = TrueClass)
-      raise EmptyWhitelist if whitelist.is_a?(Array) && whitelist.size == 0
-      @whitelist = whitelist
+    def initialize(event_validator = -> (_journal, _event) { true })
+      @event_validator = event_validator
       @events = []
     end
 
-    def events
-      @events.dup.freeze
-    end
-
     def add(timestamp: Time.now, value: true)
-      validate_value(value)
-      event = Event.new(timestamp: timestamp, value: value)
+      event = OpenStruct.new({ timestamp: timestamp, value: value })
+      raise InvalidEvent unless event_validator.call(self, event)
       @events << event
       nil
     end
@@ -51,15 +39,5 @@ module Capitalism
       @events.delete_at(index)
       nil
     end
-
-    private
-
-    def validate_value(value)
-      if whitelist.is_a?(Array)
-        raise ValueIsNotWhitelisted unless whitelist.include?(value)
-      else
-        raise ValueClassMismatch unless value.is_a?(whitelist)
-      end
-    end
   end
 end

data/lib/capitalism/journal/version.rb

@@ -1,5 +1,5 @@
 module Capitalism
   class Journal
-    VERSION = '0.6.0'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: capitalism-journal
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrey Zharikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-22 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dry-struct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
-description: Incident, weight, sleep, mood, thought, etc.
+description: Payment, temperature, sleep, mood, thought, etc.
 email:
 - andrey@zharikov.pro
 executables: []
@@ -98,7 +84,6 @@ files:
 - bin/setup
 - capitalism-journal.gemspec
 - lib/capitalism/journal.rb
-- lib/capitalism/journal/event.rb
 - lib/capitalism/journal/version.rb
 homepage: https://github.com/zharikovpro/capitalism-journal
 licenses: []

data/lib/capitalism/journal/event.rb

@@ -1,12 +0,0 @@
-require 'dry-struct'
-
-module Capitalism
-  class Journal
-    class Event < Dry::Struct::Value
-      constructor_type :strict_with_defaults
-
-      attribute :timestamp, (Dry::Types['strict.time'].default { Time.now })
-      attribute :value, Dry::Types['any'].default(true)
-    end
-  end
-end