rubadana 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a631bf26519d087f84658df366b3e8215ac07d8
+  data.tar.gz: c3e5b87d59a2e137288e54bea5c6f488f23d6f98
+SHA512:
+  metadata.gz: ce23a984a846411b53048cfd7288082a3431ea4f653fb98e308e79b9a2f55ddc4914b3538b31cdc7cf02437269c1b455af784d8674bf726af519417881b79e28
+  data.tar.gz: fd437f3e95811f6f78746b093152aa02c13b35745a1c983dce38cd5f9e8333360132fe62188e0daee13c665ba3cb0b9e56a08d6f38f6d312cdfc6dbd4e1f581b

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.#*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubadana.gemspec
+gemspec

data/MIT-LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 conanite
+
+MIT License
+
+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,75 @@
+# Rubadana
+
+Rubadana is an elementary ruby data-analysis package. It works with plain old ruby objects, not sql or databases or anything fancy like that.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubadana'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubadana
+
+## Usage
+
+See spec for some examples. The basic idea:
+
+1. Create a Registry for your `Dimension` and `Accumulator` instances
+
+my_registry = Rubadana::Registry.new
+
+2. Create and register some `Dimension` instances:
+
+```ruby
+  class SaleYear < Rubadana::Dimension
+    def name                  ; "yearly"                                        ; end
+    def group_value_for thing ; thing.date.year                                 ; end
+    def value_label_for value ; value                                           ; end
+  end
+
+  my_registry.register_dimension SaleYear.new
+```
+
+3. Create and register some `Accumulator` instances:
+
+```ruby
+  class SumSaleAmount < Rubadana::Summation
+    def name            ; "sum-sale-amount"         ; end
+    def value_for thing ; thing.sale_amount         ; end
+  end
+
+  my_registry.register_accumulator SumSaleAmount.new
+```
+
+4. Build an analysis program and run it:
+
+```ruby
+  # this is a program to analyse invoices by year and product, giving the
+  # number of sales, the sum of sales and the average sale in each case
+  my_program = register.build ["yearly", "invoice-product"], ["count", "sum-sale-amount", "avg-sale-amount"]
+
+  data = my_program.run(invoices)
+```
+
+`#run` returns an array of `DataSet` each with the following attributes:
+
+* `analyser`    - a `Dimension` instance
+* `group_value` - the common value of this dimension for all objects in this data-set
+* `data`        - either an accumulated value given by an accumulator, or a nested array of `DataSet` instances
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rubadana/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rubadana/version.rb

@@ -0,0 +1,3 @@
+module Rubadana
+  VERSION = "0.0.1"
+end

data/lib/rubadana.rb

@@ -0,0 +1,77 @@
+require "rubadana/version"
+
+module Rubadana
+  class Registry
+    def initialize
+      @dimensions   = Hash.new
+      @accumulators = Hash.new
+    end
+
+    def register_dimension    d ; @dimensions[d.name.to_sym]   = d                             ; end
+    def register_accumulator  a ; @accumulators[a.name.to_sym] = a                             ; end
+    def dimensions              ; @dimensions.values                                           ; end
+    def accumulators            ; @accumulators.values                                         ; end
+    def not_nil attr, hsh, name ; hsh[name.to_sym] || raise("unknown #{attr} #{name.inspect}") ; end
+    def dimension          name ; not_nil "dimension"  , @dimensions  , name                   ; end
+    def accumulator        name ; not_nil "accumulator", @accumulators, name                   ; end
+
+    def build dnames, anames
+      dd = dnames.compact.map { |n| dimension   n }
+      aa = anames.compact.map { |n| accumulator n }
+      Program.new(dd + aa)
+    end
+  end
+
+  class DataSet < Aduki::Initializable
+    attr_accessor :analyser, :group_value, :data
+    def value_label ; analyser.value_label_for group_value ; end
+  end
+
+  class Accumulator
+    def name              ; raise "implement this and return a unique name for this accumulator"        ; end
+    def accumulate things ; raise "implement this and return a value extracted from #things"            ; end
+    def run things, after ; [DataSet.new(analyser: self, data: accumulate(things))] + after.run(things) ; end
+  end
+
+
+  class Summation < Accumulator
+    def value_for   thing ; raise "implement this and return a value extracted from #thing"       ; end
+    def accumulate things ; things.map { |thing| value_for(thing) }.reduce :+                     ; end
+  end
+
+  class Counter < Accumulator
+    def name              ; "count"           ; end
+    def accumulate things ; things.uniq.count ; end
+  end
+
+  class Average < Summation
+    def accumulate things ; super / (1.0 * things.count) ; end
+  end
+
+  class Dimension
+    def name                  ; raise "implement this and return a unique name for this dimension"    ; end
+    def group_value_for thing ; raise "implement this and return a value extracted from #thing"       ; end
+    def value_label_for value ; raise "implement this to return a display value for #{value.inspect}" ; end
+
+    def run objects, after
+      objects.group_by { |obj| group_value_for obj }.map { |value, list|
+        DataSet.new analyser: self, group_value: value, data: after.run(list)
+      }
+    end
+  end
+
+  class Program
+    attr_accessor :dimension, :after
+
+    def initialize dimensions
+      if dimensions
+        self.dimension = dimensions.first
+        self.after = Program.new dimensions[1..-1]
+      end
+    end
+
+    def run objects
+      dimension ? dimension.run(objects, after) : []
+    end
+  end
+end

data/rubadana.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubadana/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubadana"
+  spec.version       = Rubadana::VERSION
+  spec.authors       = ["Conan Dalton"]
+  spec.email         = ["conan@conandalton.net"]
+  spec.summary       = %q{ Simple data grouping and calculations                             }
+  spec.description   = %q{ Simple data grouping and calculations. Bring your own extractors. }
+  spec.homepage      = "http://github.com/conanite/rubadana"
+  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.add_dependency "aduki", "~> 0.2.3"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end

data/spec/analyse_invoices_spec.rb

@@ -0,0 +1,220 @@
+require "spec_helper"
+
+describe "analyse invoices" do
+  def date str ; Date.parse str ; end
+
+  class Invoice < Aduki::Initializable
+    attr_accessor :type, :date, :amount
+  end
+
+  class InvoiceMonth < Rubadana::Dimension
+    def name                  ; "monthly"                                       ; end
+    def group_value_for thing ; Date.new(thing.date.year, thing.date.month, 1)  ; end # rails just use #beginning_of_month
+    def value_label_for value ; value.strftime "%B %Y"                          ; end # better with I18n
+  end
+
+  class InvoiceYear < Rubadana::Dimension
+    def name                  ; "yearly"                                        ; end
+    def group_value_for thing ; thing.date.year                                 ; end
+    def value_label_for value ; value                                           ; end
+  end
+
+  class InvoiceType < Rubadana::Dimension
+    def name                  ; "type"                                          ; end
+    def group_value_for thing ; thing.type                                      ; end
+    def value_label_for value ; value.to_s                                      ; end
+  end
+
+  class InvoiceScale < Rubadana::Dimension
+    def name                  ; "scale"                                         ; end
+    def group_value_for thing ; Math.log(thing.amount, 10).to_i                 ; end
+    def value_label_for value ; value                                           ; end
+  end
+
+  class InvoiceSum < Rubadana::Summation
+    def name            ; "sum-amount" ; end
+    def value_for thing ; thing.amount ; end
+  end
+
+  class InvoiceAvg < Rubadana::Average
+    def name            ; "avg-amount" ; end
+    def value_for thing ; thing.amount ; end
+  end
+
+  let(:i00) { Invoice.new type: "SalesInvoice"      , date: date("2020-02-01"), amount:     53 }
+  let(:i01) { Invoice.new type: "PurchaseInvoice"   , date: date("2021-04-02"), amount:   1100 }
+  let(:i02) { Invoice.new type: "SalesCreditNote"   , date: date("2020-02-03"), amount:  23000 }
+  let(:i03) { Invoice.new type: "SalesCreditNote"   , date: date("2021-04-04"), amount:   3100 }
+  let(:i04) { Invoice.new type: "Quote"             , date: date("2020-05-05"), amount:  43000 }
+  let(:i05) { Invoice.new type: "Order"             , date: date("2021-12-06"), amount:     59 }
+  let(:i06) { Invoice.new type: "SalesInvoice"      , date: date("2020-02-07"), amount:   6100 }
+  let(:i07) { Invoice.new type: "PurchaseInvoice"   , date: date("2022-06-08"), amount:  79000 }
+  let(:i08) { Invoice.new type: "PurchaseCreditNote", date: date("2020-05-09"), amount:  83000 }
+  let(:i09) { Invoice.new type: "SalesInvoice"      , date: date("2020-05-10"), amount:    990 }
+  let(:i10) { Invoice.new type: "SalesInvoice"      , date: date("2022-06-11"), amount:    130 }
+  let(:i11) { Invoice.new type: "PurchaseInvoice"   , date: date("2022-12-12"), amount:   1700 }
+  let(:i12) { Invoice.new type: "SalesInvoice"      , date: date("2020-11-13"), amount:  19000 }
+  let(:i13) { Invoice.new type: "PurchaseCreditNote", date: date("2020-11-14"), amount:     23 }
+  let(:i14) { Invoice.new type: "SalesInvoice"      , date: date("2021-04-15"), amount:    110 }
+  let(:i15) { Invoice.new type: "SalesInvoice"      , date: date("2022-06-16"), amount: 170000 }
+
+  let(:invoices) { [ i00,i01,i02,i03,i04,i05,i06,i07,i08,i09,i10,i11,i12,i13,i14,i15 ]}
+  let(:register) { Rubadana::Registry.new }
+
+  before {
+    register.register_dimension   InvoiceYear.new
+    register.register_dimension   InvoiceMonth.new
+    register.register_dimension   InvoiceType.new
+    register.register_dimension   InvoiceScale.new
+    register.register_accumulator InvoiceSum.new
+    register.register_accumulator InvoiceAvg.new
+    register.register_accumulator Rubadana::Counter.new
+  }
+
+  it "groups items by month and counts them" do
+    program  = register.build ["monthly"], ["count"]
+    data     = program.run(invoices)
+    actual   = data.sort_by(&:group_value).map { |d| [d.value_label] +  d.data.map(&:data) }
+    expected = [
+                ["February 2020", 3],
+                ["May 2020"     , 3],
+                ["November 2020", 2],
+                ["April 2021"   , 3],
+                ["December 2021", 1],
+                ["June 2022"    , 3],
+                ["December 2022", 1],
+               ]
+    expect(actual).to eq expected
+  end
+
+  it "groups items by year and sums them" do
+    program  = register.build ["yearly"], ["sum-amount"]
+    data     = program.run(invoices)
+    actual   = data.sort_by(&:group_value).map { |d| [d.value_label] +  d.data.map(&:data) }
+    expected = [
+                [2020, 175166],
+                [2021,   4369],
+                [2022, 250830],
+               ]
+    expect(actual).to eq expected
+  end
+
+  it "groups items by year and counts them" do
+    program  = register.build ["yearly"], ["count"]
+    data     = program.run(invoices)
+    actual   = data.sort_by(&:group_value).map { |d| [d.value_label] +  d.data.map(&:data) }
+    expected = [
+                [2020, 8],
+                [2021, 4],
+                [2022, 4],
+               ]
+    expect(actual).to eq expected
+  end
+
+  it "groups items by year and averages them" do
+    program  = register.build ["yearly"], ["avg-amount"]
+    data     = program.run(invoices)
+    actual   = data.sort_by(&:group_value).map { |d| [d.value_label] +  d.data.map(&:data) }
+    expected = [
+                [2020, 21895.75],
+                [2021,  1092.25],
+                [2022, 62707.5 ],
+               ]
+    expect(actual).to eq expected
+  end
+
+  it "groups items by year and gives the count, sum, and average" do
+    program  = register.build ["yearly"], ["count", "sum-amount", "avg-amount"]
+    data     = program.run(invoices)
+    actual   = data.sort_by(&:group_value).map { |d| [d.value_label] + d.data.map(&:data) }
+    expected = [
+                [2020, 8, 175166, 21895.75],
+                [2021, 4,   4369,  1092.25],
+                [2022, 4, 250830, 62707.5 ],
+               ]
+    expect(actual).to eq expected
+  end
+
+  it "groups items by year and by type and by scale and counts them" do
+    program  = register.build ["yearly", "type"], ["count"]
+    data     = program.run(invoices)
+    actual   = data.sort_by(&:group_value).inject([]) { |arr, d|
+      d.data.sort_by(&:group_value).each { |s|
+        arr << [d.value_label, s.value_label] + s.data.map(&:data) }
+      arr
+    }
+
+    expected = [
+                [2020 , "PurchaseCreditNote" , 2 ],
+                [2020 , "Quote"              , 1 ],
+                [2020 , "SalesCreditNote"    , 1 ],
+                [2020 , "SalesInvoice"       , 4 ],
+                [2021 , "Order"              , 1 ],
+                [2021 , "PurchaseInvoice"    , 1 ],
+                [2021 , "SalesCreditNote"    , 1 ],
+                [2021 , "SalesInvoice"       , 1 ],
+                [2022 , "PurchaseInvoice"    , 2 ],
+                [2022 , "SalesInvoice"       , 2 ],
+               ]
+    expect(actual).to eq expected
+  end
+
+  it "groups items by scale and by type and sums them" do
+    program  = register.build ["scale", "type"], ["sum-amount"]
+    data     = program.run(invoices)
+    actual   = data.sort_by(&:group_value).inject([]) { |arr, d|
+      d.data.sort_by(&:group_value).each { |s|
+        arr << [d.value_label, s.value_label] +  s.data.map(&:data) }
+      arr
+    }
+
+    expected = [
+                [1 , "Order"              , 59     ] ,
+                [1 , "PurchaseCreditNote" , 23     ] ,
+                [1 , "SalesInvoice"       , 53     ] ,
+                [2 , "SalesInvoice"       , 1230   ] ,
+                [3 , "PurchaseInvoice"    , 2800   ] ,
+                [3 , "SalesCreditNote"    , 3100   ] ,
+                [3 , "SalesInvoice"       , 6100   ] ,
+                [4 , "PurchaseCreditNote" , 83000  ] ,
+                [4 , "PurchaseInvoice"    , 79000  ] ,
+                [4 , "Quote"              , 43000  ] ,
+                [4 , "SalesCreditNote"    , 23000  ] ,
+                [4 , "SalesInvoice"       , 19000  ] ,
+                [5 , "SalesInvoice"       , 170000 ] ]
+
+    expect(actual).to eq expected
+  end
+
+  it "groups items by year and by type and by scale and counts them" do
+    program  = register.build ["yearly", "type", "scale"], ["sum-amount"]
+    data     = program.run(invoices)
+    actual   = data.sort_by(&:group_value).inject([]) { |arr, d|
+      d.data.sort_by(&:group_value).each { |s|
+        s.data.sort_by(&:group_value).each { |z|
+          arr << [d.value_label, s.value_label, z.value_label] + z.data.map(&:data) }
+      }
+      arr
+    }
+
+    expected = [
+                [2020 , "PurchaseCreditNote" , 1 , 23.0     ],
+                [2020 , "PurchaseCreditNote" , 4 , 83000.0  ],
+                [2020 , "Quote"              , 4 , 43000.0  ],
+                [2020 , "SalesCreditNote"    , 4 , 23000.0  ],
+                [2020 , "SalesInvoice"       , 1 , 53.0     ],
+                [2020 , "SalesInvoice"       , 2 , 990.0    ],
+                [2020 , "SalesInvoice"       , 3 , 6100.0   ],
+                [2020 , "SalesInvoice"       , 4 , 19000.0  ],
+                [2021 , "Order"              , 1 , 59.0     ],
+                [2021 , "PurchaseInvoice"    , 3 , 1100.0   ],
+                [2021 , "SalesCreditNote"    , 3 , 3100.0   ],
+                [2021 , "SalesInvoice"       , 2 , 110.0    ],
+                [2022 , "PurchaseInvoice"    , 3 , 1700.0   ],
+                [2022 , "PurchaseInvoice"    , 4 , 79000.0  ],
+                [2022 , "SalesInvoice"       , 2 , 130.0    ],
+                [2022 , "SalesInvoice"       , 5 , 170000.0 ]
+               ]
+    expect(actual).to eq expected
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'aduki'
+require 'rubadana'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rubadana
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Conan Dalton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aduki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " Simple data grouping and calculations. Bring your own extractors. "
+email:
+- conan@conandalton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubadana.rb
+- lib/rubadana/version.rb
+- rubadana.gemspec
+- spec/analyse_invoices_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/conanite/rubadana
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple data grouping and calculations
+test_files:
+- spec/analyse_invoices_spec.rb
+- spec/spec_helper.rb