acts_as_customized_attributes 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Mzc4ZjUwY2U4YWNmNDRiMzg1MDFlNjgyODhiZmQwYTJkMDA1ODllOA==
+  data.tar.gz: !binary |-
+    ZTUzZDE5YWIxYjQwZDlmODAyMGNlNjkxY2RmODVkM2U2ZTk5YjJmNw==
+SHA512:
+  metadata.gz: !binary |-
+    YzQ0YzZiYWMxYWI4YzQxYTExMDE1N2JiMDJkMDJjMTM3N2Q3OGVjNzdmNDgw
+    ODRjNWE5ZjBjMjRiYjNhMTQ0NWMyZTYwZTBlNDNlNzA1YTQ2ODBiZDhhZmM4
+    M2FhZjMyN2U2YWM0YzRkZGZmNTU3MDRiZDI4ZWY3ZWY5YmM1M2M=
+  data.tar.gz: !binary |-
+    ZDFjNTYzYzhiZDY4NWJjNWRmMjQyZDZlMDIyYjY1MTBlZDAyOTYyMTgzNTFj
+    OGU5MTA0NDQ3NGU3NzJhMmEwZWFlYzlkMzljYjY1ZDVlYTE5NDhlNzE1NTI2
+    NzJlNjE4MmViOTEwNjIzMWI1NmQ3MmJlNWVjMmI0Y2Q1ZDRhOTQ=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.md

@@ -0,0 +1,73 @@
+[![Build Status](https://api.shippable.com/projects/546b3f7bd46935d5fbbde6b9/badge?branchName=master)](https://app.shippable.com/projects/546b3f7bd46935d5fbbde6b9/builds/latest)
+[![Code Climate](https://codeclimate.com/github/kaspernj/acts_as_customized_attributes/badges/gpa.svg)](https://codeclimate.com/github/kaspernj/acts_as_customized_attributes)
+[![Test Coverage](https://codeclimate.com/github/kaspernj/acts_as_customized_attributes/badges/coverage.svg)](https://codeclimate.com/github/kaspernj/acts_as_customized_attributes)
+
+# ActsAsCustomizedAttributes
+
+Add custom attributes to your models, which doesn't have predefined names but can be created runtime, and still be able to do queries on that data.
+
+
+## Install
+
+### Bundle
+
+Add this to your Gemfile and bundle:
+```ruby
+gem 'acts_as_customized_attributes'
+```
+
+### Modify model
+
+```ruby
+class SomeModel
+  acts_as_customized_attributes
+end
+```
+
+### Create a migration
+
+This creates the tables "some_model_data_keys" and "some_model_data", where the custom attributes will be stored.
+
+```ruby
+class AddCustomizedAttributesForSomeModel < ActiveRecord::Migration
+  def up
+    SomeModel.create_customized_attributes!
+  end
+  
+  def down
+    SomeModel.drop_customized_attributes!
+  end
+end
+```
+
+## Usage
+
+### Set customized attributes for a model.
+
+```ruby
+some_model.update_customized_attributes(my_custom_attribute: 5)
+```
+
+### Get all custom attributes for a model.
+
+```ruby
+some_model.customized_attributes #=> {:my_custom_attribute => 5}
+```
+
+### Queries
+
+#### Query keys.
+
+```ruby
+SomeModel::DataKey.where("name LIKE '%facebook%'")
+```
+
+### Query data
+
+```ruby
+SomeModel::Data.where("resource_id > 5")
+```
+
+## License
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsCustomizedAttributes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks

data/app/models/acts_as_customized_attributes/data.rb

@@ -0,0 +1,3 @@
+class ActsAsCustomizedAttributes::Data < ActiveRecord::Base
+  belongs_to :resource, polymorphic: true
+end

data/app/models/acts_as_customized_attributes/data_key.rb

@@ -0,0 +1,3 @@
+class ActsAsCustomizedAttributes::DataKey < ActiveRecord::Base
+  validates_presence_of :name
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/acts_as_customized_attributes/class_methods.rb

@@ -0,0 +1,76 @@
+module ActsAsCustomizedAttributes::ClassMethods
+  def acts_as_customized_attributes(args = {})
+    $aaca_class_name_key = "#{name}DataKey"
+    $aaca_class_name_data = "#{name}Data"
+
+    class_data_key = Class.new(ActsAsCustomizedAttributes::DataKey) do
+      set_table_name $aaca_class_name_key.tableize
+
+      has_many :data, class_name: $aaca_class_name_data, dependent: :destroy
+    end
+
+    class_data = Class.new(ActsAsCustomizedAttributes::Data) do
+      set_table_name $aaca_class_name_data.tableize
+
+      belongs_to :data_key, class_name: $aaca_class_name_key
+
+      validates_associated :data_key
+    end
+
+    Object.const_set($aaca_class_name_key, class_data_key)
+    Object.const_set($aaca_class_name_data, class_data)
+
+    include ActsAsCustomizedAttributes::InstanceMethods
+
+    has_many :data, class_name: "#{name}Data", foreign_key: "resource_id", dependent: :destroy
+  end
+
+  def create_customized_attributes!
+    migration_class.new.migrate(:up)
+  end
+
+  def drop_customized_attributes!
+    migration_class.new.migrate(:down)
+  end
+
+  def aaca_key_class
+    @aaca_key_class ||= Object.const_get("#{name}DataKey")
+  end
+
+  def aaca_data_class
+    @aaca_data_class ||= Object.const_get("#{name}Data")
+  end
+
+private
+
+  def migration_class
+    $acts_as_customized_attributes_keys_table_name = "#{name.downcase}_data_keys"
+    $acts_as_customized_attributes_table_name = "#{name.downcase}_data"
+
+    clazz = Class.new(ActiveRecord::Migration) do
+      def up
+        create_table $acts_as_customized_attributes_keys_table_name do |t|
+          t.string :name
+          t.string :title
+          t.timestamps
+        end
+
+        add_index $acts_as_customized_attributes_keys_table_name, :name
+
+        create_table $acts_as_customized_attributes_table_name do |t|
+          t.belongs_to :resource
+          t.belongs_to :data_key
+          t.string :value
+          t.timestamps
+        end
+
+        add_index $acts_as_customized_attributes_table_name, :data_key_id
+      end
+
+      def down
+        drop_table $acts_as_customized_attributes_table_name
+        drop_table $acts_as_customized_attributes_keys_table_name
+      end
+    end
+  end
+end

data/lib/acts_as_customized_attributes/compatibility.rb

@@ -0,0 +1,5 @@
+module ActsAsCustomizedAttributes::Compatibility
+  def self.included(base)
+    base.extend ActsAsCustomizedAttributes::ClassMethods
+  end
+end

data/lib/acts_as_customized_attributes/engine.rb

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

data/lib/acts_as_customized_attributes/instance_methods.rb

@@ -0,0 +1,20 @@
+module ActsAsCustomizedAttributes::InstanceMethods
+  def update_customized_data(data)
+    data.each do |key, value|
+      key = self.class.aaca_key_class.find_or_create_by_name(key)
+
+      data = self.class.aaca_data_class.find_or_initialize_by_data_key_id_and_resource_id(key.id, id)
+      data.value = value
+      data.save!
+    end
+  end
+
+  def customized_data
+    hash = {}
+    data.includes(:data_key).each do |data_i|
+      hash[data_i.data_key.name.to_sym] = data_i.value
+    end
+
+    return hash
+  end
+end

data/lib/acts_as_customized_attributes/version.rb

@@ -0,0 +1,3 @@
+module ActsAsCustomizedAttributes
+  VERSION = "0.0.2"
+end

data/lib/acts_as_customized_attributes.rb

@@ -0,0 +1,13 @@
+require "acts_as_customized_attributes/engine"
+
+module ActsAsCustomizedAttributes
+  extend ActiveSupport::Autoload
+
+  autoload :InstanceMethods
+  autoload :ClassMethods
+  autoload :Compatibility
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActsAsCustomizedAttributes::Compatibility
+end

data/lib/tasks/acts_as_customized_attributes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_customized_attributes do
+#   # Task goes here
+# end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

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/order.rb

@@ -0,0 +1,5 @@
+class Order < ActiveRecord::Base
+  acts_as_customized_attributes
+
+  belongs_to :user
+end

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

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  acts_as_customized_attributes
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "acts_as_customized_attributes"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.example.yml

@@ -0,0 +1,42 @@
+# MySQL.  Versions 4.1 and 5.0 are recommended.
+# 
+# Install the MYSQL driver
+#   gem install mysql2
+#
+# Ensure the MySQL gem is defined in your Gemfile
+#   gem 'mysql2'
+#
+# And be sure to use new-style password hashing:
+#   http://dev.mysql.com/doc/refman/5.0/en/old-client.html
+development:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: dummy_development
+  pool: 5
+  username: root
+  password:
+  socket: /var/run/mysqld/mysqld.sock
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: dummy_test
+  pool: 5
+  username: root
+  password:
+  socket: /var/run/mysqld/mysqld.sock
+
+production:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: dummy_production
+  pool: 5
+  username: root
+  password:
+  socket: /var/run/mysqld/mysqld.sock

data/spec/dummy/config/database.shippable.yml

@@ -0,0 +1,6 @@
+test:
+  adapter: mysql2
+  encoding: utf8
+  database: acts_as_customized_attributes
+  pool: 5
+  username: shippa

data/spec/dummy/config/database.yml

@@ -0,0 +1,19 @@
+development:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: customized-data-dev
+  pool: 5
+  username: customized-data
+  password: BVBaZWNHnnunP2vY
+  socket: /var/run/mysqld/mysqld.sock
+
+test:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: customized-data-test
+  pool: 5
+  username: customized-data
+  password: BVBaZWNHnnunP2vY
+  socket: /var/run/mysqld/mysqld.sock

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,30 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,60 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to Rails.root.join("public/assets")
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = 'd49e23cb89aa89048e5df737dd810dddae1fb66ddc9888aff7185108f96e896bee475c685b47e10dcf957488a16b565757849d106a25e8d7de9fa9852f07f868'