eav_hashes 1.0.0

data/lib/eav_hashes/util.rb

@@ -0,0 +1,122 @@
+module ActiveRecord
+  module EavHashes
+    module Util
+      # Sanity checks!
+      # @param [Hash] options the options hash to check for emptyness and Hashiness
+      def self.sanity_check(options)
+        raise "options cannot be empty (and you shouldn't be calling this since you left options blank)" if
+            (!options.is_a? Hash) or options.empty?
+      end
+
+      # Fills in any options not explicitly passed to eav_hash_for and creates an EavEntry type for the table
+      # @param [Hash] options the options hash to be filled with defaults on unset keys.
+      def self.fill_options_hash(options)
+        sanity_check options
+
+        # Generate a unique class name based on the eav_hash's name and owner
+        options[:entry_class_name] ||= "#{options[:parent_class_name]}_#{options[:hash_name]}_entry".camelize.to_sym
+
+        # Strip "_entries" from the table name
+        if /Entry$/.match options[:entry_class_name]
+          options[:table_name] ||= options[:entry_class_name].to_s.tableize.slice(0..-9).to_sym
+        else
+          options[:table_name] ||= options[:entry_class_name].to_s.tableize.to_sym
+        end
+
+        # Create the symbol name for the "belongs_to" association in the entry model
+        options[:parent_assoc_name] ||= "#{options[:parent_class_name].to_s.underscore}".to_sym
+
+        # Create the symbol name for the "has_many" association in the parent model
+        options[:entry_assoc_name] = options[:entry_class_name].to_s.tableize.to_sym
+
+        # Change slashes to underscores in options to match what's output by the generator
+        # TODO: Refactor table naming into one location
+        options[:table_name] = options[:table_name].to_s.gsub(/\//,'_').to_sym
+        options[:parent_assoc_name] = options[:parent_assoc_name].to_s.gsub(/\//,'_').to_sym
+        options[:entry_assoc_name] = options[:entry_assoc_name].to_s.gsub(/\//,'_').to_sym
+
+        # Create our custom type if it doesn't exist already
+        options[:entry_class] = create_eav_table_class options
+
+        return options
+      end
+
+      # Creates a new type subclassed from ActiveRecord::EavHashes::EavEntry which represents an eav_hash key-value pair
+      def self.create_eav_table_class (options)
+        sanity_check options
+
+        # Don't overwrite an existing type
+        return class_from_string(options[:entry_class_name].to_s) if class_from_string_exists?(options[:entry_class_name])
+
+        # Create our type
+        klass = set_constant_from_string options[:entry_class_name].to_s, Class.new(ActiveRecord::EavHashes::EavEntry)
+
+        # Fill in the associations and specify the table it belongs to
+        klass.class_eval <<-END_EVAL
+          self.table_name = "#{options[:table_name]}"
+          belongs_to :#{options[:parent_assoc_name]}
+        END_EVAL
+
+        return klass
+      end
+
+      # Searches an EavEntry's table for the specified key/value pair and returns an
+      # array containing the IDs of the models whose eav_hash key/value pair.
+      # You should not run this directly.
+      # @param [String, Symbol] key the key to search by
+      # @param [Object] value the value to search by. if this is nil, it will return all models which contain `key`
+      # @param [Hash] options the options hash which eav_hash_for hash generated.
+      def self.run_find_expression (key, value, options)
+        sanity_check options
+        raise "Can't search for a nil key!" if key.nil?
+        if value.nil?
+          options[:entry_class].where(
+              "entry_key = ? and symbol_key = ?",
+              key.to_s,
+              key.is_a?(Symbol)
+          ).pluck("#{options[:parent_assoc_name]}_id".to_sym)
+        else
+          val_type = EavEntry.get_value_type value
+          if val_type == EavEntry::SUPPORTED_TYPES[:Object]
+            raise "Can't search by Objects/Hashes/Arrays!"
+          else
+            options[:entry_class].where(
+                "entry_key = ? and symbol_key = ? and value = ? and value_type = ?",
+                key.to_s,
+                key.is_a?(Symbol),
+                value.to_s,
+                val_type
+            ).pluck("#{options[:parent_assoc_name]}_id".to_sym)
+          end
+        end
+      end
+
+      # Find a class even if it's contained in one or more modules.
+      # See http://stackoverflow.com/questions/3163641/get-a-class-by-name-in-ruby
+      def self.class_from_string(str)
+        str.split('::').inject(Object) do |mod, class_name|
+          mod.const_get(class_name)
+        end
+      end
+
+      # Check whether a class exists, even if it's contained in one or more modules.
+      def self.class_from_string_exists?(str)
+        begin
+          class_from_string(str)
+        rescue
+          return false
+        end
+        true
+      end
+
+      # Set a constant from a string, even if the string contains modules. Modules
+      # are created if necessary.
+      def self.set_constant_from_string(str, val)
+        parent = str.deconstantize.split('::').inject(Object) do |mod, class_name|
+          mod.const_defined?(class_name) ? mod.const_get(class_name) : mod.const_set(class_name, Module.new())
+        end
+        parent.const_set(str.demodulize.to_sym, val)
+      end
+    end
+  end
+end

data/lib/eav_hashes/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module EavHashes
+    VERSION = "1.0.0"
+  end
+end

data/lib/generators/eav_migration/USAGE

@@ -0,0 +1,26 @@
+Description:
+    Creates a DB migration to generate the schema for a table which is used to
+    store the entries of an eav_hash.
+
+Example:
+    If you're not setting a custom table name, i.e., your model looks like this:
+
+        class ModelName < ActiveRecord::Base
+            eav_hash_for :hash_name
+        end
+
+    Then simply run this migration like so:
+
+        rails generate eav_migration ModelName hash_name
+
+    However, if you're a wizard and have specified a custom table name like this:
+
+        class ModelName < ActiveRecord::Base
+            eav_hash_for :hash_name, :table_name => :custom_table
+        end
+
+    Then run this generator like this:
+
+        rails generate eav_migration ModelName hash_name custom_table
+
+    Easy as pie!

data/lib/generators/eav_migration/eav_migration.rb

@@ -0,0 +1,36 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+class EavMigrationGenerator < ActiveRecord::Generators::Base
+
+  source_root File.expand_path "../templates", __FILE__
+  # small hack to override NamedBase displaying NAME
+  argument :name, :required => true, :type => :string, :banner => "<ModelName>"
+  argument :hash_name, :required => true, :type => :string, :banner => "<hash_name>"
+  argument :custom_table_name, :required => false, :type => :string, :banner => "table_name"
+
+  def create_eav_migration
+    p name
+    migration_template "eav_migration.erb", "db/migrate/#{migration_file_name}.rb"
+  end
+
+  def migration_file_name
+    "create_" + table_name
+  end
+
+  def migration_name
+    migration_file_name.camelize
+  end
+
+  def table_name
+    custom_table_name || "#{name}_#{hash_name}".underscore.gsub(/\//, '_')
+  end
+
+  def model_name
+    name
+  end
+
+  def model_association_name
+    model_name.underscore.gsub(/\//,'_')
+  end
+end

data/lib/generators/eav_migration/templates/eav_migration.erb

@@ -0,0 +1,16 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def change
+    create_table :<%= table_name %> do |t|
+      t.references :<%= model_association_name %>, :null => false
+      t.string :entry_key, :null => false
+      t.text :value, :null => false
+      t.integer :value_type, :null => false
+      t.boolean :symbol_key, :null => false, :default => true
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :<%= model_association_name %>_id
+    add_index :<%= table_name %>, :entry_key
+  end
+end

data/lib/tasks/eav_hashes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :eav_hashes do
+#   # Task goes here
+# 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
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- 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.