denormalizer 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,5 +1,11 @@
 == unreleased changes
 
+== 0.0.2
+
+* Added basic testing for the mixins
+* Changed the scope names to plurals
+* Added instance methods to check for individual denormalized method outputs
+
 == 0.0.1
 
 * Added mixin with denormalize_all, denormalize, and also_denormalize methods

data/README.rdoc

@@ -31,10 +31,10 @@ Denormalize associations.  This will run the denormalization method on each of t
 
 Use the denormalized data
 
-    Book.denormalized_active
-    Book.denormalized_not_active
+    Book.denormalized_actives
+    Book.denormalized_not_actives
         
-    Book.first.denormalized_active? (coming soon)
+    Book.first.denormalized_active?
 
 == Thought Process
 
@@ -56,8 +56,10 @@ The first minimizes code duplication but is not chainable and often slower than
 
 == Todo
 
-* Improve test coverage
-* Add methods to directly access denormalized data from model instances
+* Add code to make sure association denormalization does loop infinitely
+* Improve testing on the Denormalizer::MethodOutput model
+* Refactor dome of the denormalize mixin code to the MethodOutput model
+* Figure out how to replace mysql with a different database/memory store system
 
 == Contributing to denormalizer
  

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/app/models/denormalizer/method_output.rb

@@ -6,4 +6,13 @@ class Denormalizer::MethodOutput < ActiveRecord::Base
 
   FalseOutput = 0
   TrueOutput = 1
+
+  def self.by_object_and_method_name(obj, method_name)
+    attributes = {
+      :denormalized_object_type => obj.class.name, 
+      :denormalized_object_id => obj.id, 
+      :denormalized_object_method => method_name
+    }
+    where(attributes).limit(1)
+  end
 end

data/denormalizer.gemspec

@@ -0,0 +1,128 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "denormalizer"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremiah Hemphill"]
+  s.date = "2012-07-13"
+  s.description = "Cache method outputs and automatically create chainable scopes based on their outputs"
+  s.email = "jeremiah@cloudspace.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/models/denormalizer/method_output.rb",
+    "denormalizer.gemspec",
+    "lib/denormalizer.rb",
+    "lib/denormalizer/config.rb",
+    "lib/denormalizer/denormalize.rb",
+    "lib/denormalizer/engine.rb",
+    "lib/denormalizer/railtie.rb",
+    "lib/generators/denormalizer/install_generator.rb",
+    "lib/generators/denormalizer/templates/config.rb",
+    "lib/generators/denormalizer/templates/migrations/install_migration.rb.erb",
+    "spec/association_denormalization_spec.rb",
+    "spec/denormalize_all_spec.rb",
+    "spec/denormalizer_spec.rb",
+    "spec/dummy/Rakefile",
+    "spec/dummy/app/controllers/application_controller.rb",
+    "spec/dummy/app/helpers/application_helper.rb",
+    "spec/dummy/app/models/book.rb",
+    "spec/dummy/app/models/printing.rb",
+    "spec/dummy/app/views/layouts/application.html.erb",
+    "spec/dummy/config.ru",
+    "spec/dummy/config/application.rb",
+    "spec/dummy/config/boot.rb",
+    "spec/dummy/config/database.yml",
+    "spec/dummy/config/environment.rb",
+    "spec/dummy/config/environments/development.rb",
+    "spec/dummy/config/environments/production.rb",
+    "spec/dummy/config/environments/test.rb",
+    "spec/dummy/config/initializers/backtrace_silencers.rb",
+    "spec/dummy/config/initializers/denormalizer.rb",
+    "spec/dummy/config/initializers/inflections.rb",
+    "spec/dummy/config/initializers/mime_types.rb",
+    "spec/dummy/config/initializers/secret_token.rb",
+    "spec/dummy/config/initializers/session_store.rb",
+    "spec/dummy/config/locales/en.yml",
+    "spec/dummy/config/routes.rb",
+    "spec/dummy/db/migrate/20120706021202_book.rb",
+    "spec/dummy/db/migrate/20120706125004_create_denormalizer_tables.rb",
+    "spec/dummy/db/schema.rb",
+    "spec/dummy/public/404.html",
+    "spec/dummy/public/422.html",
+    "spec/dummy/public/500.html",
+    "spec/dummy/public/favicon.ico",
+    "spec/dummy/public/javascripts/application.js",
+    "spec/dummy/public/javascripts/controls.js",
+    "spec/dummy/public/javascripts/dragdrop.js",
+    "spec/dummy/public/javascripts/effects.js",
+    "spec/dummy/public/javascripts/prototype.js",
+    "spec/dummy/public/javascripts/rails.js",
+    "spec/dummy/public/stylesheets/.gitkeep",
+    "spec/dummy/script/rails",
+    "spec/integration/navigation_spec.rb",
+    "spec/method_denormalization_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/jeremiahishere/denormalizer"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Cache method outputs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_development_dependency(%q<capybara>, [">= 0.4.0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<rspec-rails>, ["~> 2.6.1"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.3"])
+      s.add_development_dependency(%q<ci_reporter>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_dependency(%q<capybara>, [">= 0.4.0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<rspec-rails>, ["~> 2.6.1"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.3"])
+      s.add_dependency(%q<ci_reporter>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
+    s.add_dependency(%q<capybara>, [">= 0.4.0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<rspec-rails>, ["~> 2.6.1"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.3"])
+    s.add_dependency(%q<ci_reporter>, [">= 0"])
+  end
+end
+

data/lib/denormalizer/denormalize.rb

@@ -35,7 +35,7 @@ module Denormalizer
             "denormalizer_method_outputs.denormalized_object_method" => method_name.to_s,
             "denormalizer_method_outputs.method_output" => Denormalizer::MethodOutput::TrueOutput
           }
-          true_scope_name = "denormalized_#{method_name.to_s.gsub('?', '')}".to_sym
+          true_scope_name = "denormalized_#{method_name.to_s.gsub('?', '')}".pluralize.to_sym
           scope true_scope_name, lambda { joins(:denormalized_method_outputs).where(true_attributes)}
 
           # setup false scope
@@ -43,8 +43,14 @@ module Denormalizer
             "denormalizer_method_outputs.denormalized_object_method" => method_name.to_s,
             "denormalizer_method_outputs.method_output" => Denormalizer::MethodOutput::FalseOutput
           }
-          false_scope_name = "denormalized_not_#{method_name.to_s.gsub('?', '')}".to_sym
+          false_scope_name = "denormalized_not_#{method_name.to_s.gsub('?', '')}".pluralize.to_sym
           scope false_scope_name, lambda { joins(:denormalized_method_outputs).where(false_attributes)}
+
+          instance_method_name = "denormalized_#{method_name.to_s}"
+          define_method instance_method_name do
+            saved_output = Denormalizer::MethodOutput.by_object_and_method_name(self, method_name).first
+            return saved_output.method_output == Denormalizer::MethodOutput::TrueOutput
+          end
         end
 
         after_save :method_denormalization
@@ -76,14 +82,16 @@ module Denormalizer
             method_output = self.send(method_name) ? Denormalizer::MethodOutput::TrueOutput : Denormalizer::MethodOutput::FalseOutput
 
             # find a match then create or update based on success
-            attributes = {
-              :denormalized_object_type => self.class.name, 
-              :denormalized_object_id => self.id, 
-              :denormalized_object_method => method_name
-            }
-            saved_output = Denormalizer::MethodOutput.where(attributes).limit(1).first
+            # TODO: refactor this entire section to metho on Denormalizer::MethodOutput (JH 7-13-2012)
+            saved_output = Denormalizer::MethodOutput.by_object_and_method_name(self, method_name).first
             if saved_output.nil?
-              Denormalizer::MethodOutput.create(attributes.merge({ :method_output => method_output }))
+              attributes = {
+                :denormalized_object_type => self.class.name,
+                :denormalized_object_id => self.id,
+                :denormalized_object_method => method_name,
+                :method_output => method_output
+              }
+              Denormalizer::MethodOutput.create(attributes)
             else
               saved_output.method_output = method_output
               saved_output.save
@@ -93,6 +101,8 @@ module Denormalizer
       end
 
       def association_denormalization
+        # TODO: make sure this doesn't loop infinitely (JH 7-13-2012)
+        # if two models have a circular association or a model has a self association, this will not work
         self.denormalized_associations.each do |assoc_method|
           assoc = self.send(assoc_method)
           if assoc.is_a?(Array)

data/spec/association_denormalization_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe "association denormalization" do
+  before(:each) { @printing = Printing.new }
+  subject { @printing }
+
+  describe "class methods" do
+    describe "also_denormalize" do
+      it "should add to the denormalized_associations array" do
+        @printing.denormalized_associations.should include :book      
+      end
+
+      it "should add association_denormalization to the after_save" do
+        @printing.should_receive(:association_denormalization)
+        @printing.save(:validate => false)
+      end
+    end
+  end
+
+  describe "instance methods" do
+    describe "association_denormalization" do
+      before(:each) do
+        @book = Book.new
+      end
+
+      it "should call method_denormalization for the association" do
+        @printing.book = @book
+        @book.should_receive(:method_denormalization)
+        @printing.association_denormalization
+      end
+
+      it "should call method_denormalization for each member of the association if it is an array" do
+        @printing.stub(:book).and_return([@book])
+        @book.should_receive(:method_denormalization)
+        @printing.association_denormalization
+      end
+    end
+  end
+end

data/spec/denormalize_all_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "denormalize_all" do
+  describe "class methods" do
+    describe "denormalize_all" do
+      it "should call method_denormalization on all instances of the object" do
+        @book = Book.new
+        Book.stub(:all).and_return([@book])
+        @book.should_receive(:method_denormalization)
+        Book.denormalize_all
+      end
+
+      it "should call association_denormalization on all instances of the object" do
+        @printing = Printing.new
+        Printing.stub(:all).and_return([@printing])
+        @printing.should_receive(:association_denormalization)
+        Printing.denormalize_all
+      end
+    end
+  end
+end

data/spec/method_denormalization_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+require 'ruby-debug'
+
+describe "method denormalization" do
+  before(:each) { @book = Book.new }
+  subject { @book }
+
+  describe "class methods" do
+    describe "denormalize" do
+      it "should add to the denormalized_method_outputs array" do
+        @book.denormalized_methods.should include :short_name?      
+        @book.denormalized_methods.should include :printed?      
+      end
+
+      it "should create a scope called denormalized_method_names for the method method_name?" do
+        Book.should respond_to :denormalized_short_names
+      end
+
+      it "should create a scope called denormalized_not_method_names for the method method_name?" do
+        Book.should respond_to :denormalized_not_short_names
+      end
+
+      it "should add method_denormalization to the after_save" do
+        @book.should_receive(:method_denormalization)
+        @book.save(:validate => false)
+      end
+    end
+  end
+
+  # these tests are dependent on the Book model denormalizing the short_name? and printed?
+  describe "scopes" do
+    describe "denormalized_short_names" do
+      it "should match this sql" do
+        sql = Book.denormalized_short_names.to_sql 
+        sql.should match "INNER JOIN \"denormalizer_method_outputs\" ON \"denormalizer_method_outputs\".\"denormalized_object_id\" = \"books\".\"id\" AND \"denormalizer_method_outputs\".\"denormalized_object_type\" = 'Book'"
+        sql.should match "WHERE \"denormalizer_method_outputs\".\"denormalized_object_method\" = 'short_name.' AND \"denormalizer_method_outputs\".\"method_output\" = 1"
+      end
+    end
+
+    describe "denormalized_not_short_names" do
+      it "should match this sql" do
+        sql = Book.denormalized_not_short_names.to_sql 
+        sql.should match "INNER JOIN \"denormalizer_method_outputs\" ON \"denormalizer_method_outputs\".\"denormalized_object_id\" = \"books\".\"id\" AND \"denormalizer_method_outputs\".\"denormalized_object_type\" = 'Book'"
+        sql.should match "WHERE \"denormalizer_method_outputs\".\"denormalized_object_method\" = 'short_name.' AND \"denormalizer_method_outputs\".\"method_output\" = 0"
+      end
+    end
+  end
+
+  describe "methods" do
+    describe "denormalized_short_name?" do
+      it "should include the denormalized method" do
+        @book.should respond_to :denormalized_short_name?
+      end
+
+      it "should match the actual output if synced" do
+        @book.name = "abc"
+        @book.save
+        @book.short_name?.should equal @book.denormalized_short_name?
+      end
+    end
+
+    describe "method_denormalization" do
+      before(:each) do
+        @book.stub(:new_record?).and_return(false)
+        @book.stub(:id).and_return(1000)
+        @book.name = "The Tale of Two Cities"
+      end
+
+      it "should do nothing for new records" do
+        @book.stub(:new_record?).and_return(true)
+        @book.should_not_receive(:denormalized_methods)
+        @book.method_denormalization
+      end
+
+      it "should call each denormalized method" do
+        @book.should_receive(:short_name?)
+        @book.should_receive(:printed?)
+        @book.method_denormalization
+      end
+
+      it "should save the output of each denormalized method to the database" do
+        @book.method_denormalization
+        Denormalizer::MethodOutput.where(:denormalized_object_type => "Book", :denormalized_object_id => 1000, :denormalized_object_method => "short_name?").should_not be_empty
+      end
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: denormalizer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jeremiah Hemphill
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-06 00:00:00 Z
+date: 2012-07-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -142,6 +142,7 @@ files:
 - Rakefile
 - VERSION
 - app/models/denormalizer/method_output.rb
+- denormalizer.gemspec
 - lib/denormalizer.rb
 - lib/denormalizer/config.rb
 - lib/denormalizer/denormalize.rb
@@ -150,6 +151,8 @@ files:
 - lib/generators/denormalizer/install_generator.rb
 - lib/generators/denormalizer/templates/config.rb
 - lib/generators/denormalizer/templates/migrations/install_migration.rb.erb
+- spec/association_denormalization_spec.rb
+- spec/denormalize_all_spec.rb
 - spec/denormalizer_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/application_controller.rb
@@ -189,6 +192,7 @@ files:
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
 - spec/integration/navigation_spec.rb
+- spec/method_denormalization_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/jeremiahishere/denormalizer
 licenses: 
@@ -203,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2066004463778552460
+      hash: 3695816084296706715
       segments: 
       - 0
       version: "0"