report_logic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e25770ff6e1144dbbdba31d2cd5ce7c18b754fc
+  data.tar.gz: 01b93068112f0428369d7bf05f7c595cfc483e71
+SHA512:
+  metadata.gz: e7cc1c97d098b1595c8799f45c1d69954976b6628655c9868e30eff3038c1ba33a9680b41ba919a71c50256e0c49b455ec9dc2391214b3d507589b5476ff5ed4
+  data.tar.gz: fff161688583ee20d397030165b647b15e3b419ee196d81892e311b717fb0b38b264975a05f645394053bf0e190ac784ed2898734d04140e54b981838b4f4c5a

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/README.md

@@ -0,0 +1,20 @@
+# ReportLogic
+
+This gem provides an easy way to generate reports' logic.
+Using this, you can so export this report to any format you want.
+
+## Installation
+
+```bash
+gem install report_logic
+```
+
+Using bundler:
+
+```ruby
+gem 'report_logic'
+```
+
+## Usage
+
+Building...

data/lib/report_logic/base.rb

@@ -0,0 +1,59 @@
+module ReportLogic
+  class Base
+    include Decorable
+
+    attr_reader :collection
+
+    def initialize(collection = nil)
+      @collection = collection
+    end
+
+    def each(key)
+      return to_enum(__callee__, key) unless block_given?
+      ensure_built_and_decorated
+      sessions[key] and sessions[key].fields.each { |field| yield field }
+    end
+
+    def session(key, collection = nil, &block)
+      @current_session = sessions[key] ||= Session.new(key, self)
+      @current_session.process(collection, &block)
+    end
+
+    def count
+      @collection.size
+    end
+
+    def method_missing(method_name, *args, &block)
+      if @current_session && @current_session.public_methods.include?(method_name)
+        @current_session.public_send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    protected
+
+    def ensure_built_and_decorated
+      build    unless @built
+      decorate unless @decorated
+      @built     = true
+      @decorated = true
+    end
+
+    def build
+      raise NotImplementedError
+    end
+
+    def decorate
+      sessions.values.each do |sess|
+        sess.decorate(@decorators)
+      end
+    end
+
+    private
+
+    def sessions
+      @sessions ||= {}
+    end
+  end
+end

data/lib/report_logic/decorable.rb

@@ -0,0 +1,17 @@
+module ReportLogic
+  module Decorable
+    def decorators
+      @decorators ||= []
+    end
+
+    def decorate_with(dec)
+      if dec
+        if dec.respond_to?(:each)
+          dec.each { |dec| decorators << dec }
+        else
+          decorators << dec
+        end
+      end
+    end
+  end
+end

data/lib/report_logic/decorator.rb

@@ -0,0 +1,26 @@
+module ReportLogic
+  class Decorator
+    attr_accessor :key
+
+    def initialize(key: nil)
+      @key = key
+    end
+
+    def decorate(field)
+      decorate_name(field)
+      decorate_value(field)
+    end
+
+    def decorate_name(field); end
+
+    def decorate_value(field); end
+
+    def decorate_if_matches(field)
+      decorate(field) if matches?(field)
+    end
+
+    def matches?(field)
+      key.nil? || key == field.key || Array === key && key.include?(field.key)
+    end
+  end
+end

data/lib/report_logic/field.rb

@@ -0,0 +1,35 @@
+module ReportLogic
+  class Field
+    include Decorable
+
+    attr_accessor :key, :value, :type, :name
+
+    def initialize(name, value=nil, type: nil, key: nil, decorate_with: nil)
+      @name  = name
+      @value = value
+      @type  = type
+      @key   = key || (name.is_a?(Symbol) ? name : nil)
+      self.decorate_with(decorate_with)
+    end
+
+    def type
+      @type ||= guess_type
+    end
+
+    def guess_type
+      @value.class
+    end
+
+    def decorate(master_decorators = nil)
+      apply_decorators(master_decorators) if master_decorators
+      apply_decorators(decorators)
+    end
+
+    def apply_decorators(decorators)
+      decorators.each do |dec|
+        dec.decorate_if_matches(self)
+      end
+      self
+    end
+  end
+end

data/lib/report_logic/i18n_decorator.rb

@@ -0,0 +1,13 @@
+module ReportLogic
+  class I18nDecorator < Decorator
+    include I18nHelper
+
+    def decorate_name(field, name=field.name, **options)
+      field.name  = i18n_lookup(:names , name, **options) if Symbol === name
+    end
+
+    def decorate_value(field, value=field.value, **options)
+      field.value  = i18n_lookup(:values , value, **options) if Symbol === value
+    end
+  end
+end

data/lib/report_logic/i18n_helper.rb

@@ -0,0 +1,14 @@
+require 'i18n'
+
+module ReportLogic
+  module I18nHelper
+    def i18n_lookup(scope, key, default: key.to_sym, resource_class: nil, **options)
+      lookup = if resource_class
+        :"#{resource_class.to_s.downcase.underscore}.#{key}"
+      else
+        key
+      end
+      I18n.t(lookup, scope: [:report, scope], default: default, **options)
+    end
+  end
+end

data/lib/report_logic/i18n_support.rb

@@ -0,0 +1,7 @@
+module ReportLogic
+  module I18nSupport
+    def i18n_decorate
+      decorators << I18nDecorator.new
+    end
+  end
+end

data/lib/report_logic/session.rb

@@ -0,0 +1,51 @@
+module ReportLogic
+  class Session
+    include Decorable
+
+    attr_accessor :key, :report
+
+    def initialize(key = nil, report = nil)
+      @key, @report = key, report
+    end
+
+    def fields
+      @fields ||= []
+    end
+
+    def current_row
+      @current_row ||= fields
+    end
+
+    def field(name, value = nil, **options)
+      current_row << Field.new(name, value, **options)
+    end
+
+    def value(val, **options)
+      field(nil, val, **options)
+    end
+
+    def process(collection = nil)
+      if collection.respond_to?(:each)
+        collection.each do |record|
+          @current_row = []
+          yield record
+          fields.push current_row
+          @current_row = nil
+        end
+      else
+        yield
+      end
+    end
+
+    def decorate(master_decorators = nil)
+      master_decorators ||= []
+      fields.each do |field_or_row|
+        if field_or_row.respond_to?(:each)
+          field_or_row.each { |f| f.decorate(master_decorators + decorators) }
+        else
+          field_or_row.decorate(master_decorators + decorators)
+        end
+      end
+    end
+  end
+end

data/lib/report_logic.rb

@@ -0,0 +1,10 @@
+module ReportLogic
+  autoload :Base         , 'report_logic/base'
+  autoload :Decorable    , 'report_logic/decorable'
+  autoload :Decorator    , 'report_logic/decorator'
+  autoload :Field        , 'report_logic/field'
+  autoload :Session      , 'report_logic/session'
+  autoload :I18nDecorator, 'report_logic/i18n_decorator'
+  autoload :I18nSupport  , 'report_logic/i18n_support'
+  autoload :I18nHelper   , 'report_logic/i18n_helper'
+end

data/report_logic.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'report_logic'
+  s.version     = '0.0.1'
+  s.date        = '2014-09-17'
+  s.summary     = "Generating report logic."
+  s.description = "This gem provides an easy way to generate reports' logic. "\
+    "Using this, you can so export this report to any format you want."
+  s.authors     = ["Diego Aguir Selzlein"]
+  s.email       = 'diegoselzlein@gmail.com'
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.homepage    = 'https://github.com/nerde/report_logic'
+  s.license     = 'MIT'
+
+  s.add_dependency('i18n', '~> 0')
+end

data/spec/app/my_decorator.rb

@@ -0,0 +1,5 @@
+class MyDecorator < ReportLogic::Decorator
+  def decorate(field)
+    field.value = 3
+  end
+end

data/spec/app/my_i18n_report.rb

@@ -0,0 +1,12 @@
+class MyI18nReport < ReportLogic::Base
+  include ReportLogic::I18nSupport
+
+  def build
+    i18n_decorate
+
+    session(:header) do
+      field 'ID'
+      field :name, :test
+    end
+  end
+end

data/spec/app/my_report.rb

@@ -0,0 +1,23 @@
+Record = Struct.new(:id, :name)
+
+class MyReport < ReportLogic::Base
+  def build
+    session(:header) do
+      field 'ID'
+      field 'Name'
+    end
+
+    session(:rows, collection) do |record|
+      value record.id
+      value record.name
+    end
+
+    session(:test_context) do
+      context_value
+    end
+  end
+
+  def context_value
+    'A'
+  end
+end

data/spec/report_logic/base_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe ReportLogic::Base do
+  let(:rec1) { Record.new(1, 'Diego') }
+  let(:rec2) { Record.new(2, 'Andressa') }
+
+  let(:report) { MyReport.new([rec1, rec2]) }
+
+  let(:headers) { report.each(:header) }
+  let(:rows)    { report.each(:rows) }
+
+  it "generates grouped fields" do
+    expect(headers.count    ).to eql(2)
+    expect(headers.next.name).to eql('ID')
+    expect(headers.next.name).to eql('Name')
+
+
+    expect(rows.count    ).to eql(2)
+
+    first_row = rows.next
+    expect(first_row.first.value).to eql(1)
+    expect(first_row.last.value ).to eql('Diego')
+
+    last_row = rows.next
+    expect(last_row.first.value ).to eql(2)
+    expect(last_row.last.value  ).to eql('Andressa')
+  end
+
+  it "counts records" do
+    expect(report.count).to eq 2
+  end
+end

data/spec/report_logic/decorator_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ReportLogic::Decorator do
+  let(:decorator) { MyDecorator.new }
+  let(:field)     { ReportLogic::Field.new(1, 2, key: :first) }
+
+  describe "#decorate_if_matches" do
+
+    it "decorates object" do
+      decorator.decorate_if_matches(field)
+
+      expect(field.value).to eql(3)
+    end
+
+    context "decorator does not match" do
+      it "doesn't decorate" do
+        decorator.stub(:matches?).and_return(false)
+
+        decorator.decorate_if_matches(field)
+
+        expect(field.value).to eql(2)
+      end
+    end
+
+    context "key doesn't match" do
+      let(:decorator) { ReportLogic::Decorator.new key: :second }
+
+      it "doesn't decorate" do
+        decorator.decorate_if_matches(field)
+
+        expect(field.value).to eql(2)
+      end
+    end
+
+    context "key is an array" do
+      let(:decorator) { MyDecorator.new key: [:second] }
+
+      it "checks inclusion" do
+        f2 = ReportLogic::Field.new(1, 2, key: :second)
+
+        decorator.decorate_if_matches(field)
+        decorator.decorate_if_matches(f2)
+
+        expect(field.value).to eql(2)
+        expect(f2   .value).to eql(3)
+      end
+    end
+  end
+end

data/spec/report_logic/i18n_support_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'i18n'
+
+describe ReportLogic::I18nSupport do
+  let(:report) { MyI18nReport.new }
+
+  let(:headers) { report.each(:header).to_a }
+
+  before(:all) do
+    I18n.enforce_available_locales = false
+    I18n.backend.store_translations(:es, report: { names: { name: 'Nombre' },
+      values: { test: 'This is translated too' } })
+    I18n.default_locale = :es
+  end
+
+  after(:all) do
+    I18n.backend = nil
+    I18n.default_locale = nil
+  end
+
+  it "translates key fields" do
+    expect(headers.size      ).to eql(2)
+    expect(headers.first.name).to eql('ID')
+    expect(headers.last .name).to eql('Nombre')
+    expect(headers.last.value).to eql('This is translated too')
+  end
+end

data/spec/report_logic/session_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe ReportLogic::Session do
+  let(:session) { ReportLogic::Session.new }
+  let(:fields)  { session.fields }
+  let(:field)   { session.fields.first }
+
+  it "generates fields with name" do
+    session.field 'Test Field'
+
+    expect(fields.size).to eq(1)
+    expect(field.key  ).to be_nil
+    expect(field.name ).to eq('Test Field')
+    expect(field.value).to be_nil
+  end
+
+  it "generates fields with value" do
+    session.value 'Test Field'
+
+    expect(fields.size).to eq(1)
+    expect(field.key  ).to be_nil
+    expect(field.name ).to be_nil
+    expect(field.value).to eq('Test Field')
+  end
+
+  it "generates fields with name and value" do
+    session.field 'Test Field', 'Value'
+
+    expect(fields.size).to eq(1)
+    expect(field.key  ).to be_nil
+    expect(field.name ).to eq('Test Field')
+    expect(field.value).to eq('Value')
+  end
+
+  it "generates fields with key" do
+    session.field 'Test Field', 'Value', key: :sparta
+
+    expect(fields.size).to eq(1)
+    expect(field.key  ).to eq(:sparta)
+    expect(field.name ).to eq('Test Field')
+    expect(field.value).to eq('Value')
+  end
+
+  it "uses name as key when it's a symbol" do
+    session.field :name
+
+    expect(fields.size).to eq(1)
+    expect(field.key  ).to eq(:name)
+    expect(field.name ).to eq(:name)
+    expect(field.value).to be_nil
+  end
+
+  it "decorates fields" do
+    session.field 'First Field' , 1
+    session.field 'Second Field', 2
+    session.decorate_with MyDecorator.new
+
+    session.decorate
+
+    expect(fields.first.value).to eq(3)
+    expect(fields.last .value).to eq(3)
+  end
+
+  it "can decorate a single field" do
+    session.field 'First Field' , 1
+    session.field 'Second Field', 2, decorate_with: MyDecorator.new
+
+    session.decorate
+
+    expect(fields.first.value).to eq(1)
+    expect(fields.last .value).to eq(3)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require File.expand_path('../../lib/report_logic', __FILE__)
+
+Dir[File.expand_path('../app/*.rb', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.order = "random"
+  config.before(:each) { GC.disable }
+  config.after(:each)  { GC.enable }
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: report_logic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Diego Aguir Selzlein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides an easy way to generate reports' logic. Using this,
+  you can so export this report to any format you want.
+email: diegoselzlein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- README.md
+- lib/report_logic.rb
+- lib/report_logic/base.rb
+- lib/report_logic/decorable.rb
+- lib/report_logic/decorator.rb
+- lib/report_logic/field.rb
+- lib/report_logic/i18n_decorator.rb
+- lib/report_logic/i18n_helper.rb
+- lib/report_logic/i18n_support.rb
+- lib/report_logic/session.rb
+- report_logic.gemspec
+- spec/app/my_decorator.rb
+- spec/app/my_i18n_report.rb
+- spec/app/my_report.rb
+- spec/report_logic/base_spec.rb
+- spec/report_logic/decorator_spec.rb
+- spec/report_logic/i18n_support_spec.rb
+- spec/report_logic/session_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nerde/report_logic
+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: Generating report logic.
+test_files: []