denormalizer 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/CHANGELOG

@@ -0,0 +1,6 @@
+== unreleased changes
+
+== 0.0.1
+
+* Added mixin with denormalize_all, denormalize, and also_denormalize methods
+* Added generator to create the migration and config

data/Gemfile

@@ -0,0 +1,23 @@
+source "http://rubygems.org"
+
+gem "rails", ">= 3.0.0"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "capybara", ">= 0.4.0"
+  gem "sqlite3"
+
+  gem 'ruby-debug19'
+  gem "rspec", "~> 2.6.0"
+  gem "rspec-rails", "~>2.6.1"
+  gem "yard", "~> 0.6.0"
+  gem "database_cleaner"
+  gem "jeweler", "~> 1.6.3"
+
+  # hudson ci
+  gem "ci_reporter"
+end

data/Gemfile.lock

@@ -0,0 +1,154 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.8)
+    archive-tar-minitar (0.5.2)
+    arel (3.0.2)
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.3)
+      ffi (~> 1.0.6)
+    ci_reporter (1.7.0)
+      builder (>= 2.1.2)
+    columnize (0.3.6)
+    database_cleaner (0.7.2)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    ffi (1.0.11)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    journey (1.0.4)
+    json (1.7.3)
+    libwebsocket (0.1.3)
+      addressable
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (< 2.0, >= 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.24.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    sqlite3 (1.3.6)
+    thor (0.15.4)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (>= 0.4.0)
+  ci_reporter
+  database_cleaner
+  jeweler (~> 1.6.3)
+  rails (>= 3.0.0)
+  rspec (~> 2.6.0)
+  rspec-rails (~> 2.6.1)
+  ruby-debug19
+  sqlite3
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jeremiah Hemphill
+
+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.rdoc

@@ -0,0 +1,76 @@
+= denormalizer
+
+Run and cache methods so they can be used later.  Create chainable scopes using the cached outputs of the methods.
+
+== Installation
+
+Add to your Gemfile
+
+    gem "denormalizer"
+
+Run the installer
+
+    rails generate denormalizer:install
+    rake db:migrate
+
+Denormalize a method in a model.  This will run the method and save the result every time the model is updated.
+
+    class Widget < ActiveRecord::Base
+      def active?
+        do_something_complex
+      end
+      denormalize :active?
+    end
+
+Denormalize associations.  This will run the denormalization method on each of the objects in the association.
+
+    class Item < ActiveRecord::Base
+      has_many :widgets
+      also_denormalize :widgets
+    end
+
+Use the denormalized data
+
+    Book.denormalized_active
+    Book.denormalized_not_active
+        
+    Book.first.denormalized_active? (coming soon)
+
+== Thought Process
+
+I am trying to avoid duplicating complex code in instance methods and scopes.  Given this method,
+
+    def active?
+      received_at >= Time.now && items.expired.empty?
+    end
+
+You have two choices to get all active records,
+
+    def self.active
+      all.select(&:active?)
+    end
+
+    scope :active, lambda { where(["widgets.received_at >= ?", Time.now]).where("(select count(*) from items where items.widget_id=widgets.id and (expired_at is null or expired_at >= ?)) = 0", Time.now]) }
+
+The first minimizes code duplication but is not chainable and often slower than the pure sql version.  The second solution is fast and chainable but requires two updates every time the active? criteria needs to be updated.  Additionally, it requires an updated whenever the Item model's expired scope is updated.
+
+== Todo
+
+* Improve test coverage
+* Add methods to directly access denormalized data from model instances
+
+== Contributing to denormalizer
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Jeremiah Hemphill. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "denormalizer"
+  gem.homepage = "http://github.com/jeremiahishere/denormalizer"
+  gem.license = "MIT"
+  gem.summary = %Q{Cache method outputs}
+  gem.description = %Q{Cache method outputs and automatically create chainable scopes based on their outputs}
+  gem.email = "jeremiah@cloudspace.com"
+  gem.authors = ["Jeremiah Hemphill"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "denormalizer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/models/denormalizer/method_output.rb

@@ -0,0 +1,9 @@
+class Denormalizer::MethodOutput < ActiveRecord::Base
+  set_table_name "denormalizer_method_outputs"
+
+  belongs_to :denormalized_object, :polymorphic => true
+  validates_presence_of :denormalized_object_type, :denormalized_object_id, :denormalized_object_method, :method_output
+
+  FalseOutput = 0
+  TrueOutput = 1
+end

data/lib/denormalizer/config.rb

@@ -0,0 +1,30 @@
+# this file was stolen from kaminari
+require 'active_support/configurable'
+
+module Denormalizer 
+
+  # create new configs by passing a block with the config assignment
+  def self.configure(&block)
+    yield @config ||= Denormalizer::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  # setup config data
+  class Configuration
+    include ActiveSupport::Configurable
+    # config_accessor :sample_config_key
+
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call() : config.param_name
+    end
+  end
+
+  # setup default options
+  # this should match the generator config that goes in the initializer file
+  configure do |config|
+    # config.sample_config_key =' sample_config_value'
+  end
+end

data/lib/denormalizer/denormalize.rb

@@ -0,0 +1,109 @@
+module Denormalizer
+  module Denormalize
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def denormalize_all
+        all.each do |o|
+          # this could easily be rewritten in a less stupid way
+          o.method_denormalization if self.respond_to? :denormalized_methods
+          o.association_denormalization if self.respond_to? :denormalized_associations
+        end
+      end
+
+      def denormalize(args)
+        # setup list of denormalized methods 
+        mattr_accessor :denormalized_methods unless respond_to? :denormalized_methods
+        self.denormalized_methods = [] unless self.denormalized_methods.is_a?(Array)
+
+        # add association
+        has_many :denormalized_method_outputs, :class_name => 'Denormalizer::MethodOutput', :as => :denormalized_object, :dependent => :destroy
+
+        # add args to denormalized method list
+        args = [args] unless args.is_a?(Array)
+        self.denormalized_methods |= args
+
+        # create scopes
+        # note that at some point, we probably need to identify these as denormalized scopes (JH 7-5-2012)
+        # dn_method_name maybe
+        args.each do |method_name|
+          # setup true scope
+          true_attributes = { 
+            "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
+          scope true_scope_name, lambda { joins(:denormalized_method_outputs).where(true_attributes)}
+
+          # setup false scope
+          false_attributes = {
+            "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
+          scope false_scope_name, lambda { joins(:denormalized_method_outputs).where(false_attributes)}
+        end
+
+        after_save :method_denormalization
+
+        include Denormalizer::Denormalize::InstanceMethods
+      end
+
+      def also_denormalize(args)
+        mattr_accessor :denormalized_associations unless respond_to? :denormalized_associations
+        self.denormalized_associations = [] unless self.denormalized_associations.is_a?(Array)
+
+        args = [args] unless args.is_a?(Array)
+        self.denormalized_associations |= args
+
+        after_save :association_denormalization
+
+        include Denormalizer::Denormalize::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+
+      def method_denormalization
+        # don't even try if a new record
+        if !new_record?
+          # iterate over the saved methods 
+          self.denormalized_methods.each do |method_name|
+            # run the method and save the result
+            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
+            if saved_output.nil?
+              Denormalizer::MethodOutput.create(attributes.merge({ :method_output => method_output }))
+            else
+              saved_output.method_output = method_output
+              saved_output.save
+            end
+          end
+        end
+      end
+
+      def association_denormalization
+        self.denormalized_associations.each do |assoc_method|
+          assoc = self.send(assoc_method)
+          if assoc.is_a?(Array)
+            assoc.each do |a|
+              a.method_denormalization
+            end
+          else
+            assoc.method_denormalization
+          end
+        end
+      end
+    end
+  end
+end

data/lib/denormalizer/engine.rb

@@ -0,0 +1,4 @@
+module Denormalizer 
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/denormalizer/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails'
+
+require 'denormalizer/config'
+
+module Denormalizer 
+  class Railtie < ::Rails::Railtie
+    initializer 'denormalizer' do |app|
+      require "denormalizer/denormalize"
+      ActiveRecord::Base.send :include, Denormalizer::Denormalize
+    end
+  end
+end
+

data/lib/denormalizer.rb

@@ -0,0 +1,2 @@
+require "denormalizer/railtie"
+require "denormalizer/engine"

data/lib/generators/denormalizer/install_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+
+module Denormalizer 
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path(File.join(File.dirname(__FILE__), "templates"))
+
+      desc <<DESC
+Description:
+  Copies over migrations and config for the denormalizer.
+DESC
+
+      # Implement the required interface for Rails::Generators::Migration.
+      # thanks Kaminari gem for this bit of code
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      # Creates the config file
+      # Commented out until the config actually has information
+      def copy_config_file
+        copy_file "config.rb", "config/initializers/denormalizer.rb"
+      end
+
+      # Creates the migration
+      def copy_migration
+        migration_template "migrations/install_migration.rb.erb", "db/migrate/create_denormalizer_tables.rb"
+      end
+    end
+  end
+end

data/lib/generators/denormalizer/templates/config.rb

@@ -0,0 +1,3 @@
+Denormalizer.configure do |config|
+  # config.sample_config_key =' sample_config_value'
+end

data/lib/generators/denormalizer/templates/migrations/install_migration.rb.erb

@@ -0,0 +1,20 @@
+class  <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :denormalizer_method_outputs do |t|
+      t.string :denormalized_object_type
+      t.integer :denormalized_object_id
+      t.string :denormalized_object_method
+      t.integer :method_output
+
+      t.timestamps
+    end
+    # used to get the result of a method from a single single object
+    add_index :denormalizer_method_outputs, [:denormalized_object_type, :denormalized_object_id, :denormalized_object_method], :name => "denormalized_method_object_pair"
+    # used to get all of the instances of a class with the same output for the given method
+    add_index :denormalizer_method_outputs, [:denormalized_object_type, :denormalized_object_method, :method_output], :name => "denormalized_method_type_output_triplet"
+  end
+
+  def self.down
+    drop_table :denormalizer_method_outputs
+  end
+end

data/spec/denormalizer_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Denormalizer do
+  it "should be valid" do
+    Denormalizer.should be_a(Module)
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/book.rb

@@ -0,0 +1,15 @@
+class Book < ActiveRecord::Base
+  has_many :printings
+
+  validates_presence_of :name
+
+  def short_name?
+    name.length < 5
+  end
+  denormalize :short_name?
+
+  def printed?
+    !printings.empty?
+  end
+  denormalize :printed?
+end

data/spec/dummy/app/models/printing.rb

@@ -0,0 +1,4 @@
+class Printing < ActiveRecord::Base
+  belongs_to :book
+  also_denormalize :book
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>