mochigome 0.0.2

data/test/unit/model_extensions_test.rb

@@ -0,0 +1,367 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+describe "an ActiveRecord model" do
+  before do
+    @model_class = Class.new(ActiveRecord::Base)
+    @model_class.class_eval do
+      set_table_name :fake
+      def name
+        "Moby"
+      end
+      def last_name
+        "Dick"
+      end
+    end
+    Whale = @model_class
+  end
+
+  after do
+    Object.send(:remove_const, :Whale)
+  end
+
+  it "indicates if it acts_as_mochigome_focus or not" do
+    refute @model_class.acts_as_mochigome_focus?
+    @model_class.class_eval do
+      acts_as_mochigome_focus
+    end
+    assert @model_class.acts_as_mochigome_focus?
+  end
+
+  it "cannot call acts_as_mochigome_focus more than once" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus
+    end
+    assert_raises Mochigome::ModelSetupError do
+      @model_class.class_eval do
+        acts_as_mochigome_focus
+      end
+    end
+  end
+
+  it "inherits a parent's report focus settings" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.type_name "Foobar"
+      end
+    end
+    @sub_class = Class.new(@model_class)
+    i = @sub_class.new
+    assert_equal "Foobar", i.mochigome_focus.type_name
+  end
+
+  it "can override a parent's report focus settings" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.type_name "Foobar"
+      end
+    end
+    @sub_class = Class.new(@model_class)
+    @sub_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.type_name "Narfbork"
+      end
+    end
+    i = @sub_class.new
+    assert_equal "Narfbork", i.mochigome_focus.type_name
+  end
+
+  it "uses its class name as the default type name" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus
+    end
+    i = @model_class.new
+    assert_equal "Whale", i.mochigome_focus.type_name.split("::").last
+  end
+
+  it "can override the default type name" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.type_name "Thingie"
+      end
+    end
+    i = @model_class.new
+    assert_equal "Thingie", i.mochigome_focus.type_name
+  end
+
+  it "cannot specify a nonsense type name" do
+    assert_raises Mochigome::ModelSetupError do
+      @model_class.class_eval do
+        acts_as_mochigome_focus do |f|
+          f.type_name 12345
+        end
+      end
+    end
+  end
+
+  it "uses the attribute 'name' as the default focus name" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus
+    end
+    i = @model_class.new
+    assert_equal "Moby", i.mochigome_focus.name
+  end
+
+  it "can override the focus name with another method_name" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.name :last_name
+      end
+    end
+    i = @model_class.new
+    assert_equal "Dick", i.mochigome_focus.name
+  end
+
+  it "can override the focus name with a custom implementation" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.name lambda {|obj| "#{obj.name} #{obj.last_name}"}
+      end
+    end
+    i = @model_class.new
+    assert_equal "Moby Dick", i.mochigome_focus.name
+  end
+
+  it "can specify fields" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.fields ["a", "b"]
+      end
+    end
+    i = @model_class.new(:a => "abc", :b => "xyz")
+    expected = ActiveSupport::OrderedHash.new
+    expected["a"] = "abc"
+    expected["b"] = "xyz"
+    assert_equal expected, i.mochigome_focus.field_data
+  end
+
+  it "has no report focus data if no fields are specified" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus
+    end
+    i = @model_class.new(:a => "abc", :b => "xyz")
+    assert_empty i.mochigome_focus.field_data
+  end
+
+  it "can specify only some of its fields" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.fields ["b"]
+      end
+    end
+    i = @model_class.new(:a => "abc", :b => "xyz")
+    expected = ActiveSupport::OrderedHash.new
+    expected["b"] = "xyz"
+    assert_equal expected, i.mochigome_focus.field_data
+  end
+
+  it "can specify fields in a custom order" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.fields ["b", "a"]
+      end
+    end
+    i = @model_class.new(:a => "abc", :b => "xyz")
+    expected = ActiveSupport::OrderedHash.new
+    expected["b"] = "xyz"
+    expected["a"] = "abc"
+    assert_equal expected, i.mochigome_focus.field_data
+  end
+
+  it "can specify fields with multiple calls" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.fields ["a"]
+        f.fields ["b"]
+      end
+    end
+    i = @model_class.new(:a => "abc", :b => "xyz")
+    expected = ActiveSupport::OrderedHash.new
+    expected["a"] = "abc"
+    expected["b"] = "xyz"
+    assert_equal expected, i.mochigome_focus.field_data
+  end
+
+  it "can specify fields with custom names" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.fields [{:Abraham => :a}, {:Barcelona => :b}]
+      end
+    end
+    i = @model_class.new(:a => "abc", :b => "xyz")
+    expected = ActiveSupport::OrderedHash.new
+    expected["Abraham"] = "abc"
+    expected["Barcelona"] = "xyz"
+    assert_equal expected, i.mochigome_focus.field_data
+  end
+
+  it "can specify fields with custom implementations" do
+    @model_class.class_eval do
+      acts_as_mochigome_focus do |f|
+        f.fields [{:concat => lambda {|obj| obj.a + obj.b}}]
+      end
+    end
+    i = @model_class.new(:a => "abc", :b => "xyz")
+    expected = ActiveSupport::OrderedHash.new
+    expected["concat"] = "abcxyz"
+    assert_equal expected, i.mochigome_focus.field_data
+  end
+
+  it "cannot call f.fields with nonsense" do
+    assert_raises Mochigome::ModelSetupError do
+      @model_class.class_eval do
+        acts_as_mochigome_focus do |f|
+          f.fields 123
+        end
+      end
+    end
+    assert_raises Mochigome::ModelSetupError do
+      @model_class.class_eval do
+        acts_as_mochigome_focus do |f|
+          f.fields [789]
+        end
+      end
+    end
+  end
+
+  [:name, :id, :type, :internal_type].each do |n|
+    it "cannot specify fields named the same as reserved term '#{n}'" do
+      assert_raises Mochigome::ModelSetupError do
+        @model_class.class_eval do
+          acts_as_mochigome_focus do |f|
+            f.fields [n]
+          end
+        end
+      end
+      assert_raises Mochigome::ModelSetupError do
+        @model_class.class_eval do
+          acts_as_mochigome_focus do |f|
+            f.fields [n.to_s.titleize]
+          end
+        end
+      end
+      assert_raises Mochigome::ModelSetupError do
+        @model_class.class_eval do
+          acts_as_mochigome_focus do |f|
+            f.fields [{n => :foo}]
+          end
+        end
+      end
+    end
+  end
+
+  it "appears in Mochigome's global model list if it acts_as_mochigome_focus" do
+    assert !Mochigome.reportFocusModels.include?(@model_class)
+    @model_class.class_eval do
+      acts_as_mochigome_focus
+    end
+    assert Mochigome.reportFocusModels.include?(@model_class)
+  end
+
+  it "can specify aggregated data to be collected" do
+    @model_class.class_eval do
+      has_mochigome_aggregations [:average_x, :Count, "sum x"]
+    end
+    # Peeking in past API to make sure it set the expressions correctly
+    assert_equal [
+      {:name => "Whales average x", :expr => "avg(x)"},
+      {:name => "Whales Count", :expr => "count()"},
+      {:name => "Whales sum x", :expr => "sum(x)"}
+    ], @model_class.mochigome_aggregations
+  end
+
+  it "can specify aggregations with custom names" do
+    @model_class.class_eval do
+      has_mochigome_aggregations [{"Mean X" => "avg x"}]
+    end
+    assert_equal [
+      {:name => "Mean X", :expr => "avg(x)"}
+    ], @model_class.mochigome_aggregations
+  end
+
+  it "can specify aggregations with custom SQL expressions" do
+    @model_class.class_eval do
+      has_mochigome_aggregations [{"The Answer" => "7*6"}]
+    end
+    assert_equal [
+      {:name => "The Answer", :expr => "7*6"}
+    ], @model_class.mochigome_aggregations
+  end
+
+  it "can specify aggregations with custom conditions" do
+    @model_class.class_eval do
+      has_mochigome_aggregations [{"Blue Sales" => ["count", "color='blue'"]}]
+    end
+    assert_equal [
+      {:name => "Blue Sales", :expr => "count()", :conditions => "color='blue'"}
+    ], @model_class.mochigome_aggregations
+  end
+
+  it "cannot call has_mochigome_aggregations with nonsense" do
+    assert_raises Mochigome::ModelSetupError do
+      @model_class.class_eval do
+        has_mochigome_aggregations 3
+      end
+    end
+    assert_raises Mochigome::ModelSetupError do
+      @model_class.class_eval do
+        has_mochigome_aggregations [42]
+      end
+    end
+  end
+
+  describe "with some aggregatable data" do
+    before do
+      @store1 = create(:store)
+      @store2 = create(:store)
+      @product_a = create(:product, :name => "Product A", :price => 30)
+      @product_b = create(:product, :name => "Product B", :price => 50)
+      @sp1A = create(:store_product, :store => @store1, :product => @product_a)
+      @sp1B = create(:store_product, :store => @store1, :product => @product_b)
+      @sp2A = create(:store_product, :store => @store2, :product => @product_a)
+      @sp2B = create(:store_product, :store => @store2, :product => @product_b)
+      [
+        [2, @sp1A],
+        [4, @sp1B],
+        [7, @sp2A],
+        [3, @sp2B]
+      ].each do |num, sp|
+        num.times { create(:sale, :store_product => sp) }
+      end
+    end
+
+    it "can collect aggregate data from a report focus through an association" do
+      assert_equal 9, @product_a.mochigome_focus.aggregate_data('sales')['Sales count']
+      assert_equal 7, @product_b.mochigome_focus.aggregate_data('sales')['Sales count']
+    end
+
+    it "can collect aggregate data through all known associations with :all keyword" do
+      assert_equal 9, @product_a.mochigome_focus.aggregate_data(:all)['Sales count']
+    end
+
+    it "returns both field data and all aggregate data with the data method" do
+      data = @product_a.mochigome_focus.data
+      assert_equal 9, data['Sales count']
+      assert_equal 30, data['price']
+    end
+
+    it "can return data aggregated in the context of another class with similar assoc" do
+      focus = @product_a.mochigome_focus
+      assert_equal 2, focus.aggregate_data('sales', :context => [@sp1A])['Sales count']
+    end
+
+    it "can return data aggregated in the context through the data method" do
+      focus = @product_a.mochigome_focus
+      assert_equal 2, focus.data(:context => [@sp1A])['Sales count']
+    end
+
+    it "can return data aggregated using a custom sql expression" do
+      focus = @store1.mochigome_focus
+      assert_equal 9001, focus.data['Power level']
+    end
+
+    it "can return data aggregated using custom conditions" do
+      focus = @store1.mochigome_focus
+      assert_equal 1, focus.data['Expensive products']
+    end
+  end
+end

data/test/unit/query_test.rb

@@ -0,0 +1,202 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+describe Mochigome::Query do
+  before do
+    @category1 = create(:category, :name => "Category 1")
+    @product_a = create(:product, :name => "Product A", :category => @category1)
+    @product_b = create(:product, :name => "Product B", :category => @category1)
+
+    # Belongs to a category, but fails Category's has_many(:products) conditions
+    @product_x = create(:product, :name => "Product X", :category => @category1, :categorized => false)
+
+    @category2 = create(:category, :name => "Category 2")
+    @product_c = create(:product, :name => "Product C", :category => @category2)
+    @product_d = create(:product, :name => "Product D", :category => @category2)
+
+    @product_e = create(:product, :name => "Product E") # No category
+
+    @john = create(:owner, :first_name => "John", :last_name => "Smith")
+    @store_x = create(:store, :name => "John's Store", :owner => @john)
+
+    @jane = create(:owner, :first_name => "Jane", :last_name => "Doe")
+    @store_y = create(:store, :name => "Jane's Store (North)", :owner => @jane)
+    @store_z = create(:store, :name => "Jane's Store (South)", :owner => @jane)
+
+    @sp_xa = create(:store_product, :store => @store_x, :product => @product_a)
+    @sp_xc = create(:store_product, :store => @store_x, :product => @product_c)
+    @sp_ya = create(:store_product, :store => @store_y, :product => @product_a)
+    @sp_yb = create(:store_product, :store => @store_y, :product => @product_b)
+    @sp_ye = create(:store_product, :store => @store_y, :product => @product_e)
+    @sp_zc = create(:store_product, :store => @store_z, :product => @product_c)
+    @sp_zd = create(:store_product, :store => @store_z, :product => @product_d)
+
+    [
+      [@sp_xa, 5],
+      [@sp_xc, 3],
+      [@sp_ya, 4],
+      [@sp_yb, 6],
+      [@sp_ye, 1],
+      [@sp_zc, 2],
+      [@sp_zd, 3]
+    ].each do |sp, n|
+      n.times{create(:sale, :store_product => sp)}
+    end
+  end
+
+  # Convenience function to check DataSet output validity
+  def assert_equal_objs(a, b)
+    assert_equal a.size, b.size
+    # Not checking aggregate data because we don't know about a's context here
+    a.zip(b).each do |obj, fields|
+      obj.mochigome_focus.field_data.each do |k,v|
+        assert_equal v, fields[k]
+      end
+    end
+  end
+
+  it "returns an empty DataNode if no objects given" do
+    q = Mochigome::Query.new([Category, Product])
+    data_node = q.run([])
+    assert_empty data_node
+    assert_empty data_node.children
+  end
+
+  it "can build a one-layer DataNode" do
+    q = Mochigome::Query.new([Product])
+    data_node = q.run(@product_a)
+    assert_equal_objs [@product_a], data_node.children
+    assert_empty data_node.children[0].children
+  end
+
+  it "uses the model focus's type name for the DataNode's type name" do
+    q = Mochigome::Query.new([Store])
+    data_node = q.run(@store_x)
+    assert_equal "Storefront", data_node.children[0].type_name.to_s
+  end
+
+  it "adds an internal_type attribute containing the model class's name" do
+    q = Mochigome::Query.new([Store])
+    data_node = q.run(@store_x)
+    assert_equal "Store", data_node.children[0][:internal_type]
+  end
+
+  it "can build a two-layer tree from a record with a belongs_to association" do
+    q = Mochigome::Query.new([Category, Product])
+    data_node = q.run(@product_a)
+    assert_equal_objs [@category1], data_node.children
+    assert_equal_objs [@product_a], data_node.children[0].children
+    assert_empty data_node.children[0].children[0].children
+  end
+
+  it "can build a two-layer tree from an array of records in the second layer" do
+    q = Mochigome::Query.new([Category, Product])
+    data_node = q.run([@product_a, @product_d, @product_b])
+    assert_equal_objs [@category1, @category2], data_node.children
+    assert_equal_objs [@product_a, @product_b], data_node.children[0].children
+    assert_equal_objs [@product_d], data_node.children[1].children
+  end
+
+  it "can build a two-layer tree from a record with a has_many association" do
+    q = Mochigome::Query.new([Category, Product])
+    data_node = q.run(@category1)
+    assert_equal_objs [@category1], data_node.children
+    assert_equal_objs [@product_a, @product_b], data_node.children[0].children
+    assert_empty data_node.children[0].children[0].children
+  end
+
+  it "cannot build a DataNode tree when given disconnected layers" do
+    q = Mochigome::Query.new([Category, BoringDatum])
+    assert_raises Mochigome::QueryError do
+      data_node = q.run(@category1)
+    end
+  end
+
+  it "can build a three-layer tree from any layer" do
+    q = Mochigome::Query.new([Owner, Store, Product])
+    [
+      [@john, @jane],
+      [@store_x, @store_y, @store_z],
+      [@product_a, @product_b, @product_c, @product_d, @product_e]
+    ].each do |tgt|
+      data_node = q.run(tgt)
+      assert_equal_objs [@john, @jane], data_node.children
+      assert_equal_objs [@store_x], data_node.children[0].children
+      assert_equal_objs [@store_y, @store_z], data_node.children[1].children
+      assert_equal_objs [@product_a, @product_c],
+        data_node.children[0].children[0].children
+      assert_equal_objs [@product_c, @product_d],
+        data_node.children[1].children[1].children
+    end
+  end
+
+  it "collects aggregate data in the context of all layers when traversing down" do
+    q = Mochigome::Query.new([Owner, Store, Product])
+    data_node = q.run([@john, @jane])
+    # Store X, Product C
+    assert_equal "Product C", data_node.children[0].children[0].children[1].name
+    assert_equal 3, data_node.children[0].children[0].children[1]['Sales count']
+    # Store Z, Product C
+    assert_equal "Product C", data_node.children[1].children[1].children[0].name
+    assert_equal 2, data_node.children[1].children[1].children[0]['Sales count']
+  end
+
+  it "collects aggregate data in the context of all layers when traversing up" do
+    q = Mochigome::Query.new([Owner, Store, Product])
+    data_node = q.run(@product_c)
+    # Store X, Product C
+    assert_equal "Product C", data_node.children[0].children[0].children[0].name
+    assert_equal 3, data_node.children[0].children[0].children[0]['Sales count']
+    # Store Z, Product C
+    assert_equal "Product C", data_node.children[1].children[0].children[0].name
+    assert_equal 2, data_node.children[1].children[0].children[0]['Sales count']
+  end
+
+  it "collects aggregate data in the context of distant layers" do
+    # TODO: Implement me! I think this is necessary to justify focus_data_node_objs passing obj_stack
+  end
+
+  it "puts a comment on the root node describing the query" do
+    q = Mochigome::Query.new([Owner, Store, Product])
+    data_node = q.run([@store_x, @store_y, @store_z])
+    c = data_node.comment
+    assert_match c, /^Mochigome Version: #{Mochigome::VERSION}\n/
+    assert_match c, /\nTime: \w{3} \w{3} \d+ .+\n/
+    assert_match c, /\nLayers: Owner => Store => Product\n/
+    assert_match c, /\nAR Association Path:\n\* <- Owner.+\n\* == Store.+\n\* -> Product.+\n/
+  end
+
+  it "puts a descriptive comment on the first node of each layer" do
+    q = Mochigome::Query.new([Owner, Store, Product])
+    data_node = q.run([@store_x, @store_y, @store_z])
+
+    owner_comment = data_node.children[0].comment
+    assert owner_comment
+    assert_nil data_node.children[1].comment # No comment on second owner
+
+    store_comment = data_node.children[0].children[0].comment
+    assert store_comment
+    assert_nil data_node.children[1].children[0].comment # No comment on second store
+
+    product_comment = data_node.children[0].children[0].children[0].comment
+    assert product_comment
+    assert_nil data_node.children[0].children[0].children[1].comment # No comment on 2nd product
+
+    [owner_comment, store_comment, product_comment].each do |comment|
+      assert_match comment, /^Context:\nOwner:#{@john.id}.*\n/ # Owner is always in context
+    end
+  end
+
+  it "will not allow a query on targets of different types" do
+    q = Mochigome::Query.new([Owner, Store, Product])
+    assert_raises Mochigome::QueryError do
+      q.run([@store_x, @john])
+    end
+  end
+
+  it "will not allow a query on targets not in the layer list" do
+    q = Mochigome::Query.new([Product])
+    assert_raises Mochigome::QueryError do
+      q.run(@category1)
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: mochigome
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- David Mike Simon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: ruport
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: nokogiri
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: rgl
+  prerelease: false
+  type: :runtime
+description: Mochigome builds sophisticated report datasets from your ActiveRecord models
+email: david.mike.simon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .autotest
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- lib/data_node.rb
+- lib/exceptions.rb
+- lib/mochigome.rb
+- lib/mochigome_ver.rb
+- lib/model_extensions.rb
+- lib/query.rb
+- test/app_root/app/controllers/application_controller.rb
+- test/app_root/app/controllers/owners_controller.rb
+- test/app_root/app/models/boring_datum.rb
+- test/app_root/app/models/category.rb
+- test/app_root/app/models/owner.rb
+- test/app_root/app/models/product.rb
+- test/app_root/app/models/sale.rb
+- test/app_root/app/models/store.rb
+- test/app_root/app/models/store_product.rb
+- test/app_root/config/boot.rb
+- test/app_root/config/database-pg.yml
+- test/app_root/config/database.yml
+- test/app_root/config/environment.rb
+- test/app_root/config/environments/test.rb
+- test/app_root/config/offroad.yml
+- test/app_root/config/preinitializer.rb
+- test/app_root/config/routes.rb
+- test/app_root/db/migrate/20110817163830_create_tables.rb
+- test/app_root/vendor/plugins/mochigome/init.rb
+- test/factories.rb
+- test/test.watchr
+- test/test_helper.rb
+- test/unit/data_node_test.rb
+- test/unit/model_extensions_test.rb
+- test/unit/query_test.rb
+homepage: http://github.com/DavidMikeSimon/mochigome
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: "[none]"
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: User-customizable report generator
+test_files: []
+