capitalism-journal 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd16336c030df95231517a7ad05619832f965d7a
+  data.tar.gz: 2e61c3e0276685442583a38bda30a51180e77831
+SHA512:
+  metadata.gz: '088f828ee192e34edc91679db2565162672085158298d1aeb05525e6c4c77ce8062ad63da707c98d083dd84a9303ae1b966fd433b63d9fd2d308b563e00ce9ea'
+  data.tar.gz: 4e93e75a962dc4bd19493e6340fd9fea15019ac8be301d9ccc634259062d3551bc4df0a6678d6a53e0eae580cd2748c40614161480d12fd0fa10796a88eb2d1f

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify dependencies in capitalism-journal.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Andrey Zharikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,158 @@
+# Capitalism Journal
+
+## Track any event.
+
+Incident, payment, weight, sleep, mood, thought, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capitalism-journal'
+
+And execute:
+
+    $ bundle
+
+Or install without bundler:
+
+    $ gem install capitalism-journal
+
+## 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
+
+Explicit timestamp and value:
+    
+    journal.add(timestamp: Time.now, value: true)
+
+Default values:
+
+    journal.add # journal.add(timestamp: Time.now, value: true)
+    
+Helper methods:
+    
+    # journal.add(timestamp: Time.now, value: 1)
+    journal.add_value(1)
+    
+    # journal.add(timestamp: timestamp, value: true)
+    journal.add_timestamp(timestamp)
+
+
+## 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`.
+
+Getting events with timestamps and values:
+
+    journal = Capitalism::Journal.new
+    journal.add_timestamp(Time.now)
+    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>
+    ]
+    puts journal.events.map(&:to_h)
+    => {:timestamp=>2017-10-22 21:13:14 +0300, :value=>true}
+    => {:timestamp=>2017-10-19 21:13:17 +0300, :value=>true}
+
+Timestamps only:
+
+    # journal.events.map(&:timestamp)
+    journal.timestamps
+
+Values only:
+
+    # journal.events.map(&:value)
+    journal.values
+
+### Removing events
+
+    # always returns nil
+    journal.delete_at(index)
+
+## Usage examples
+
+### Occurrence
+
+    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
+
+    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
+
+    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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'capitalism/journal'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capitalism-journal.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capitalism/journal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capitalism-journal'
+  spec.version       = Capitalism::Journal::VERSION
+  spec.authors       = ['Andrey Zharikov']
+  spec.email         = ['andrey@zharikov.pro']
+
+  spec.summary       = 'Track any event'
+  spec.description   = 'Incident, weight, sleep, mood, thought, etc.'
+  spec.homepage      = 'https://github.com/zharikovpro/capitalism-journal'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  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'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
+end

data/lib/capitalism/journal/event.rb

@@ -0,0 +1,12 @@
+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

data/lib/capitalism/journal/version.rb

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

data/lib/capitalism/journal.rb

@@ -0,0 +1,65 @@
+require_relative 'journal/version'
+require_relative 'journal/event'
+
+module Capitalism
+  class Journal
+    class ValueClassMismatch < StandardError
+    end
+
+    class EmptyWhitelist < StandardError
+    end
+
+    class ValueIsNotWhitelisted < StandardError
+    end
+
+    attr_reader :whitelist
+
+    def initialize(whitelist = TrueClass)
+      raise EmptyWhitelist if whitelist.is_a?(Array) && whitelist.size == 0
+      @whitelist = whitelist
+      @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)
+      @events << event
+      nil
+    end
+
+    def add_value(value)
+      add(value: value)
+    end
+
+    def add_timestamp(timestamp)
+      add(timestamp: timestamp)
+    end
+
+    def timestamps
+      events.map(&:timestamp)
+    end
+
+    def values
+      events.map(&:value)
+    end
+
+    def delete_at(index)
+      @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

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: capitalism-journal
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Andrey Zharikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-22 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: Incident, weight, sleep, mood, thought, etc.
+email:
+- andrey@zharikov.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- 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: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Track any event
+test_files: []