moribus 0.0.1

data/lib/moribus/macros.rb

@@ -0,0 +1,120 @@
+module Moribus
+  # Declares a set of helper methods for more efficient use of aggregated
+  # and tracked models.
+  module Macros
+    # For each of the passed arguments, which may either be method or
+    # association names, define its delegation to the specified association.
+    # If it responds to the effective reader, delegate to it.
+    # If the subject of delegation is a method name, delegate both reader and writer.
+    # If the subject of delegation is an association name, and the association
+    # was defined via the +has_aggregated+ helper method, include the
+    # association's delegation module, effectively using attribute readers,
+    # and write the associated object. See the example below for a more
+    # expressive explanation:
+    #
+    #   class CustomerAttributes < ActiveRecord::Base
+    #     # has date_of_birth and is_military attributes
+    #     acts_as_aggregated
+    #   end
+    #
+    #   class PersonName < ActiveRecord::Base
+    #     # has first_name and last_name attributes
+    #     acts_as_aggregated
+    #   end
+    #
+    #   class CustomerInfo < ActiveRecord::Base
+    #     belongs_to :customer, :inverse_of => :customer_info
+    #
+    #     has_aggregated :customer_attributes
+    #     has_aggregated :person_name
+    #     acts_as_tracked
+    #   end
+    #
+    #   class Customer < ActiveRecord::Base
+    #     has_one_current :customer_info, :inverse_of => :customer
+    #
+    #     delegate_associated :customer_attributes, :person_name, :to => :customer_info
+    #   end
+    #
+    #   customer = Customer.new
+    #   info = customer.effective_customer_info
+    #
+    #   # note here we're skipping info.person_name building for readers and writers.
+    #   info.first_name # => nil
+    #   info.first_name = 'John'
+    #   info.date_of_birth = Date.today
+    #
+    #   customer.first_name # => 'John'
+    #   customer.is_military = true
+    #   customer.is_military == info.is_military # => true
+    #   info.is_military == info.customer_attributes.is_military # => true
+    def delegate_associated(*args)
+      options = args.extract_options!
+      name = options[:to] or raise ArgumentError.new(":to option should be provided")
+      include Extensions::DelegateAssociated unless self < Extensions::DelegateAssociated
+      effective_name = "effective_#{name}".to_sym.in?(instance_methods(false)) ? "effective_#{name}" : name
+      klass = reflect_on_association(name).klass
+
+      args.each do |association_name|
+        delegate(association_name, :to => effective_name)
+
+        if (association_reflection = klass.reflect_on_association(association_name)).present?
+          self.classes_delegating_to += [association_reflection.klass]
+          if association_reflection.respond_to?(:delegated_attribute_methods)
+            delegate("effective_#{association_name}", :to => effective_name)
+            include association_reflection.delegated_attribute_methods
+          else
+            delegate :"#{association_name}=", :to => effective_name
+          end
+        else
+          delegate :"#{association_name}=", :to => effective_name
+        end
+      end
+    end
+
+    # Define a +has_one+ association with `{:is_current => true}` value for
+    # :conditions clause. Also define acceptance of nested attributes for
+    # association and effective reader.
+    def has_one_current(name, options = {})
+      reflection = has_one name, options.merge(:conditions => {:is_current => true}).reverse_merge(:order => 'id DESC')
+      reflection.options[:is_current] = true
+      accepts_nested_attributes_for name
+      define_effective_reader_for name
+      alias_association :"current_#{name}", name
+      reflection
+    end
+    private :has_one_current
+
+    # Defines +belongs_to+ association, acceptance of nested attributes for it,
+    # defines effective reader for associated object, and extends association
+    # by special aggregated functionality (attribute delegation. See
+    # Extensions::HasAggregatedExtension)
+    def has_aggregated(name, options = {})
+      reflection = belongs_to(name, options)
+      reflection.options[:aggregated] = true
+      accepts_nested_attributes_for name
+      define_effective_reader_for name
+      extend_has_aggregated_reflection(reflection)
+      reflection
+    end
+    private :has_aggregated
+
+    # Declare a reader that will build associated object if it does not exist.
+    # We can actually extend an association's readers like:
+    #
+    #   def reader
+    #     super || build
+    #   end
+    #
+    # But this corrupts the has_one association's create_other method
+    # (and I failed to dig out why --a.kuzko). Also, this will result in
+    # failing `it { should validate_presence_of :other }` specs, since
+    # auto-building will prevent `nil` values that are used by specs.
+    def define_effective_reader_for(name)
+      class_eval <<-eoruby, __FILE__, __LINE__
+        def effective_#{name}; #{name} || build_#{name}; end
+      eoruby
+    end
+    private :define_effective_reader_for
+  end
+end

data/lib/moribus/tracked_behavior.rb

@@ -0,0 +1,91 @@
+module Moribus
+  # Adds tracked behavior to a model. A tracked model should have an
+  # 'is_current' boolean column. Whenever the changed tracked object is about
+  # to be saved, it memorizes its id, marks itself as a new record, and then
+  # allows ActiveRecord to save it via standard means. If the record was
+  # successfully saved, the memorized id is used to update the 'is_current'
+  # flag for the effectively replaced record.
+  module TrackedBehavior
+    extend ActiveSupport::Concern
+
+    included{ around_save :tracked_save_callback }
+
+    # :nodoc:
+    module ClassMethods
+      # Return the column (attribute). Its value is used as a storage for
+      # previous record id.
+      attr_reader :preceding_key_column
+    end
+
+    # The main callback for tracked behavior (see module description). Note
+    # that since AR objects are saved in transaction via AR::Transactions
+    # module, no self.class.transaction{} block is used here. If an exception
+    # has been raised during execution, the record returns to its persisted
+    # state with its old id.
+    def tracked_save_callback
+      if content_changed? && persisted?
+        to_new_record!
+        set_parent
+        begin
+          # SQL UPDATE statement is executed in first place to prevent
+          # crashing on uniqueness constraints with 'is_current' condition.
+          yield if update_current
+        ensure
+          to_persistent! if new_record?
+        end
+      else
+        yield
+      end
+    end
+    private :tracked_save_callback
+
+    # Return true if any of the columns except 'is_current' has been changed.
+    def content_changed?
+      changed? && changes.keys != ['is_current']
+    end
+    private :content_changed?
+
+    # Executes SQL UPDATE statement that sets value of 'is_current' attribute to false for a
+    # record that is subject to update. If the record has locking column, will support
+    # optimistic locking behavior.
+    def update_current
+      statement = current_to_false_sql_statement
+      affected_rows = self.class.connection.update statement
+      unless affected_rows == 1
+        raise ActiveRecord::StaleObjectError.new(self, "update_current")
+      end
+      true
+    end
+    private :update_current
+
+    # Generate an arel statement to update the 'is_current' state of the
+    # record to false. And perform the very same actions AR does for record
+    # update, but using only a single 'is_current' column.
+    #
+    # Note: the more efficient #current_to_false_sql_statement method is
+    # used instead. This is left in comments "for some future performance
+    # miracle from the arel devs" (c Bruce) --a.kuzko 2012-03-07
+    # def current_to_false_arel_statement
+    #   klass = self.class
+    #   self.is_current = false
+    #   current_attribute = arel_attributes_values(false, false, ['is_current'])
+    #   stmt = klass.unscoped.where(klass.arel_table[klass.primary_key].eq(id)).arel.compile_update(current_attribute)
+    #   self.is_current = true
+    #   stmt
+    # end
+    # private :current_to_false_arel_statement
+
+    # Generate SQL statement to be used to update 'is_current' state of record to false.
+    def current_to_false_sql_statement
+      klass = self.class
+      lock_col = klass.locking_column
+      lock_value = respond_to?(lock_col) && send(lock_col).to_i
+      "UPDATE #{klass.quoted_table_name} SET \"is_current\" = #{klass.quote_value(false)} ".tap do |sql|
+        sql << ", #{klass.quoted_locking_column} = #{klass.quote_value(lock_value + 1)} " if lock_value
+        sql << "WHERE #{klass.quoted_primary_key} = #{klass.quote_value(@_before_to_new_record_values[:id])} "
+        sql << "AND #{klass.quoted_locking_column} = #{klass.quote_value(lock_value)}" if lock_value
+      end
+    end
+    private :current_to_false_sql_statement
+  end
+end

data/lib/moribus/version.rb

@@ -0,0 +1,3 @@
+module Moribus # :nodoc:
+  VERSION = "0.0.1" # :nodoc:
+end

data/moribus.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "moribus/version"
+
+Gem::Specification.new do |s|
+  s.name        = "moribus"
+  s.version     = Moribus::VERSION
+  s.authors     = ["TMX Credit", "Artem Kuzko", "Sergey Potapov"]
+  s.email       = ["rubygems@tmxcredit.com", "a.kuzko@gmail.com", "blake131313@gmail.com"]
+  s.homepage    = "https://github.com/TMXCredit/moribus"
+  s.licenses    = ["MIT"]
+  s.summary     = %q{Introduces Aggregated and Tracked behavior to ActiveRecord::Base models}
+  s.description = %q{Introduces Aggregated and Tracked behavior to ActiveRecord::Base models, as well
+    as Macros and Extensions modules for more efficient usage.}
+
+  s.rubyforge_project = "moribus"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_dependency("rails",      "~> 3.2")
+  s.add_dependency("power_enum", "~> 1.3")
+  s.add_dependency("yard",       ">= 0")
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "sqlite3"
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.