dossier-segmenter 0.9.0

data/spec/dossier/segmenter/report_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Dossier::Segmenter::Report do
+  let(:report_class)    { Class.new(Dossier::Report) }
+  let(:segmenter_class) { report_class.const_get(:Segmenter) }
+  let(:report)          { report_class.new }
+
+  it "creates a segment subclass under its own namespace when inherited" do
+    expect(segmenter_class.ancestors).to include(Dossier::Segmenter)
+  end
+
+  it "sets its class on the created segment_class" do
+    expect(segmenter_class.report_class).to eq report_class
+  end
+
+  it "has a reference to its segmenter class" do
+    expect(CuteAnimalsReport.segmenter_class).to eq CuteAnimalsReport::Segmenter
+  end
+
+  it "does not have a segmenter if no segments have been defined" do
+    expect(report).to_not be_segmented
+  end
+end

data/spec/dossier/segmenter_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+
+describe Dossier::Segmenter do
+
+  let(:report_class)    { Class.new(Dossier::Report) }
+  let!(:segmenter_class) {
+    report_class.segmenter_class.tap do |klass|
+      klass.instance_eval do
+        segment :family
+        segment :domestic, display_name: ->(row) { "#{row[:domestic] ? 'Domestic' : 'Wild'} #{row[:group_name]}" } do
+          segment :group,  display_name: :group_name, group_by: :group_id
+        end
+      end
+    end
+  }
+  let(:headers)   { CuteAnimalsReport::HEADERS.call }
+  let(:rows)      { CuteAnimalsReport::ROWS.call    }
+  let(:results)   { mock('Results', headers: headers, rows: rows) }
+  let(:report)    { report_class.new.tap { |r| r.stub(:raw_results).and_return(results) } }
+  let(:segmenter) { report.segmenter }
+
+  describe "report data" do
+    let(:data) {
+      {
+        'canine.true.10' => [
+          ['canine', true,  10, 'foxes', 'fennec',      'tan',    9, 896, true, 1_000],
+          ['canine', true,  10, 'foxes', 'fire',        'orange', 0, 468, false, 0],
+        ],
+        'canine.false.10' => [
+          ['canine', false, 10, 'foxes', 'arctic',      'white',  5, 108, false, 2_500],
+          ['canine', false, 10, 'foxes', 'crab-eating', 'brown',  3, 328, false, 5_000],
+          ['canine', false, 10, 'foxes', 'red',         'orange', 5, 963, false, 750],
+        ],
+        'canine.true.15' => [
+          ['canine', true,  15, 'dog',   'shiba inu',   'tan',    7, 191, true, 200],
+          ['canine', true,  15, 'dog',   'labrador',    'varied', 5, 269, true, 50],
+          ['canine', true,  15, 'dog',   'beagle',      'mixed',  8, 917, true, 25],
+          ['canine', true,  15, 'dog',   'boxer',       'brown',  5, 14,  true, 50],
+        ],
+        'feline.false.22' => [
+          ['feline', false, 22, 'tiger', 'bengal',      'orange', 4, 184, false, 100_000],
+          ['feline', false, 22, 'tiger', 'siberian',    'white',  5, 970, false, 500_000],
+        ],
+        'feline.false.23' => [
+          ['feline', false, 23, 'lion',  'lion',        'tan',    5, 128, false, 100_000],
+        ],
+        'feline.true.219' => [
+          ['feline', true,  219, 'cat',  'short hair',  'varied', 6, 2062, true, 10],
+          ['feline', true,  219, 'cat',  'abyssinian',  'tan',    7, 125,  true, 20],
+          ['feline', true,  219, 'cat',  'persian',     'varied', 6, 625,  false, 50],
+          ['feline', true,  219, 'cat',  'wirehair',    'grey',   7, 758,  true, 75],
+        ]
+      }
+    }
+
+    it "stores the report rows in a hash organized by segment" do
+      expect(segmenter.data).to eq(data)
+    end
+  end
+
+  describe "instances" do
+    it "takes a report upon instantiation" do
+      expect(segmenter.report).to eq report
+    end
+
+    it "has access to the class segment chain" do
+      expect(segmenter.segment_chain.length).to eq 3
+    end
+  end
+
+  describe "class" do
+    it "has a reference to the report that created it" do
+      expect(segmenter_class.report_class).to eq report_class
+    end
+
+    it "determines headers to skip when displaying" do
+      expect(segmenter_class.skip_headers.sort).to eq %w[family group_name group_id domestic].sort
+    end
+  end
+
+  describe "DSL" do
+    describe "segment" do
+      describe "definition creation" do
+        let(:segmenter_class) { report_class.segmenter_class }
+        let(:definition)      { segmenter_class.segments.last }
+
+        it "creates a segment definition" do
+          segmenter_class.segment :foo
+          expect(definition).to be_a Dossier::Segment::Definition
+        end
+
+        it "passes the name option" do
+          segmenter_class.segment :foo
+          expect(definition.name).to eq :foo
+        end
+
+        it "passes the group_by option"  do
+          segmenter_class.segment :name, group_by: :foo
+          expect(definition.group_by).to eq :foo
+        end
+
+        it "passes the display_name option" do
+          segmenter_class.segment :name, display_name: :foo
+          expect(definition.display_name).to eq :foo
+        end
+      end
+
+      it "keeps an array of segments" do
+        expect(segmenter_class.segments.count).to eq 3
+      end
+
+      it "keeps the segments in the order defined" do
+        expect(segmenter_class.segments[0].name).to eq :family
+        expect(segmenter_class.segments[1].name).to eq :domestic
+      end
+
+      it "allows nesting segment definations" do
+        expect(segmenter_class.segments[2].name).to eq :group
+      end
+    end
+  end
+
+  describe "segment options" do
+    it 'works the way I want it to' do
+      segment = mock('Segment', key_path: 'feline.false')
+      options = segmenter.segment_options_for segment
+      expect(options.map { |hash| hash['group_id'] }).to eq [22, 23]
+    end
+  end
+
+  describe "segment traversal" do
+
+    describe "from the segmenter to the first segment" do
+      it "has an array of families" do
+        expect(report.segmenter.families.length).to eq 2
+      end
+
+      describe "to the second segment" do
+        let(:family) { report.segmenter.families.first }
+
+        it "has an array of domestics" do
+          expect(family.domestics.length).to eq 2
+        end
+
+        describe "to the third segment" do
+          let(:domestic) { family.domestics.first }
+
+          it "has an array of groups" do
+            expect(domestic.groups.length).to eq 2
+          end
+
+          describe "to the rows" do
+            let(:group) { domestic.groups.first }
+
+            it "has rows" do
+              expect(group.rows.length).to eq 2
+            end
+
+            describe "to additional rows" do
+              let(:group) { domestic.groups.last }
+
+              it "has rows" do
+                expect(group.rows.length).to eq 4
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/dummy/app/reports/cute_animals_report.rb

@@ -0,0 +1,41 @@
+class CuteAnimalsReport < Dossier::Report
+  HEADERS = -> { %w[family domestic group_id group_name name color cuteness gifs playful cost_new] }
+  ROWS    = -> { [
+    ["canine", true,  10, "foxes", "fennec",      "tan",    9, 896,  true,  1_000], 
+    ["canine", true,  10, "foxes", "fire",        "orange", 0, 468,  false, 0], 
+    ["canine", false, 10, "foxes", "arctic",      "white",  5, 108,  false, 2_500], 
+    ["canine", false, 10, "foxes", "crab-eating", "brown",  3, 328,  false, 5_000], 
+    ["canine", false, 10, "foxes", "red",         "orange", 5, 963,  false, 750], 
+    ["canine", true,  15, "dog",   "shiba inu",   "tan",    7, 191,  true,  200], 
+    ["canine", true,  15, "dog",   "labrador",    "varied", 5, 269,  true,  50], 
+    ["canine", true,  15, "dog",   "beagle",      "mixed",  8, 917,  true,  25], 
+    ["canine", true,  15, "dog",   "boxer",       "brown",  5, 14,   true,  50], 
+    ["feline", false, 22, "tiger", "bengal",      "orange", 4, 184,  false, 100_000], 
+    ["feline", false, 22, "tiger", "siberian",    "white",  5, 970,  false, 500_000],
+    ["feline", false, 23, "lion",  "lion",        "tan",    5, 128,  false, 100_000], 
+    ["feline", true,  219, "cat",  "short hair",  "varied", 6, 2062, true,  10],
+    ["feline", true,  219, "cat",  "abyssinian",  "tan",    7, 125,  true,  20], 
+    ["feline", true,  219, "cat",  "persian",     "varied", 6, 625,  false, 50], 
+    ["feline", true,  219, "cat",  "wirehair",    "grey",   7, 758,  true , 75]
+  ] }
+
+  def initialize(*)
+    super
+    self.results = OpenStruct.new(headers: HEADERS.call, rows: ROWS.call)
+  end
+
+  def format_gifs(value)
+    formatter.commafy_number(value)
+  end
+
+  def format_cost_new(value)
+    formatter.number_to_dollars(value)
+  end
+
+  class Segmenter
+    segment :family
+    segment :domestic, display_name: ->(row) { "#{row[:domestic] ? 'Domestic' : 'Wild'} #{row[:group_name]}" }
+    segment :group,    display_name: :group_name, group_by: :group_id
+  end
+end
+

data/spec/dummy/config.ru

@@ -0,0 +1,2 @@
+require File.expand_path('../config/application', __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,27 @@
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)
+
+require "action_controller/railtie"
+
+Bundler.require
+
+ApplicationController = Class.new(ActionController::Base)
+
+require 'dossier/segmenter'
+
+module Dummy
+  class Application < ::Rails::Application
+    config.cache_classes = !Rails.env.development?
+    config.active_support.deprecation = :stderr
+    config.secret_token = 'http://s3-ec.buzzfed.com/static/enhanced/webdr03/2013/5/25/8/anigif_enhanced-buzz-11857-1369483324-0.gif'
+  end
+end
+
+Dummy::Application.initialize!
+

data/spec/features/segmented_report_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "segmented report" do
+  let(:path) { dossier_report_path(report: 'cute_animals') }
+
+  before(:each) { visit path }
+  
+  it "displays the correct html" do
+    expect(page).to have_content('canine')
+    expect(page).to have_content('shiba inu')
+  end
+
+  it "does not display options that are only used for grouping" do
+    expect(page).to_not have_content('219') # group_ids
+  end
+
+  it "displays its options" do
+    pending "support options"
+    expect(page).to have_content('Some options plz!')
+  end
+
+  it "has summaries" do
+    expect(page).to have_content '$300,000.00'
+    expect(page).to have_content '3,570.0'
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/application', __FILE__)
+
+require 'simplecov'
+SimpleCov.start
+
+require 'rails/test_help'
+require 'rspec/rails'
+require 'pry'
+require 'capybara/rspec'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: dossier-segmenter
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Adam Hunter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dossier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Adds control breaks to dossier reports by defined segments based on query
+  results.
+email:
+- adamhunter@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/dossier/reports/cute_animals.html.haml
+- dossier-segmenter.gemspec
+- lib/dossier/segment.rb
+- lib/dossier/segment/chain.rb
+- lib/dossier/segment/definition.rb
+- lib/dossier/segment/rows.rb
+- lib/dossier/segment/summary.rb
+- lib/dossier/segmenter.rb
+- lib/dossier/segmenter/engine.rb
+- lib/dossier/segmenter/report.rb
+- lib/dossier/segmenter/version.rb
+- script/rails
+- spec/dossier/segment/chain_spec.rb
+- spec/dossier/segment/definition_spec.rb
+- spec/dossier/segment/rows_spec.rb
+- spec/dossier/segment/summary_spec.rb
+- spec/dossier/segment_spec.rb
+- spec/dossier/segmenter/report_spec.rb
+- spec/dossier/segmenter_spec.rb
+- spec/dummy/app/reports/cute_animals_report.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/public/favicon.ico
+- spec/features/segmented_report_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/adamhunter/dossier-segmenter
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Extends Dossier to have segmented report functionality.
+test_files:
+- spec/dossier/segment/chain_spec.rb
+- spec/dossier/segment/definition_spec.rb
+- spec/dossier/segment/rows_spec.rb
+- spec/dossier/segment/summary_spec.rb
+- spec/dossier/segment_spec.rb
+- spec/dossier/segmenter/report_spec.rb
+- spec/dossier/segmenter_spec.rb
+- spec/dummy/app/reports/cute_animals_report.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/public/favicon.ico
+- spec/features/segmented_report_spec.rb
+- spec/spec_helper.rb