deposit 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+*~
+*.gem
+*.sqlite3
+*.log

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+Deposit
+=================================
+
+Rails plugin for saving additional data for model.
+
+Requirements
+---------------------------------
+This gem is for Rails 3 with ActiveRecord and later versions only.
+
+Install
+---------------------------------
+Add this to your Gemfile: 
+
+```ruby
+    gem 'deposit'
+```
+
+run `bundle install`,
+
+And then `rails g deposit_migration`, It will create table `deposits` for you.
+
+Usage
+---------------------------------
+Simply add `as_depositable` to your model:
+
+```ruby
+class Product < ActiveRecord::Base
+  as_depositable
+end
+```
+
+you can load and save deposit like this:
+
+```ruby
+p = Product.last
+p.save_deposit :transition, {id: 123, date: Time.now}
+p.load_deposit :transition # => return saved data
+```
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :development
+
+Dir['lib/tasks/*.rake'].each { |rake| load rake }
+
+task default: :spec  
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+Bundler::GemHelper.install_tasks

data/deposit.gemspec

@@ -0,0 +1,26 @@
+$:.push File.dirname(__FILE__) + '/lib'
+
+Gem::Specification.new do |gem|
+  gem.name = "deposit"
+  gem.authors = ["linjunhalida"]
+  gem.date        = '2012-09-28'
+  gem.description = "Rails plugin for saving additional data for model."
+  gem.summary = "Saving additional data for rails model."
+  gem.email = "linjunhalida@gmail.com"
+  gem.homepage      = 'https://github.com/halida/deposit'
+
+  gem.add_runtime_dependency 'rails', '~> 3.0'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'ammeter', '~> 0.2.8'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'mysql2', '~> 0.3.7'
+  gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ['lib']
+  gem.version       = '0.0.2'
+end

data/lib/deposit.rb

@@ -0,0 +1,44 @@
+require "active_record"
+
+module Deposit
+  module Depositable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def acts_as_depositable
+        include AsDepositable      
+      end
+    end
+  end
+
+  module AsDepositable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :deposit_slots, class_name: "Deposit::DepositSlot", as: :item, dependent: :destroy
+    end
+
+    def save_deposit key, value
+      d = self.deposit_slots.find_or_create_by_key key
+      d.data = value
+      d.save
+    end
+
+    def load_deposit key
+      d = self.deposit_slots.where(key: key).first
+      return nil unless d
+      return d.data
+    end
+
+  end
+
+  class DepositSlot < ActiveRecord::Base
+    belongs_to :item, polymorphic: true
+    serialize :data
+  end
+
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, Deposit::Depositable)
+end

data/lib/generators/deposit_migration/USAGE

@@ -0,0 +1,2 @@
+Description:
+    run rails generate deposit_migration

data/lib/generators/deposit_migration/deposit_migration_generator.rb

@@ -0,0 +1,18 @@
+class DepositMigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  source_root File.expand_path('../templates', __FILE__)
+  
+  # Complete wtf that this isn't provided elsewhere.
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def manifest
+    migration_template 'migration.rb', 'db/migrate/deposit_migration'
+  end
+end

data/lib/generators/deposit_migration/templates/migration.rb

@@ -0,0 +1,15 @@
+class DepositMigration < ActiveRecord::Migration
+  def change
+    create_table :deposit_slots do |t|
+      t.integer :item_id
+      t.string :item_type
+
+      t.string :key
+      t.text :data
+
+      t.timestamps
+    end
+
+    add_index :deposit_slots, [:item_id, :item_type, :key]
+  end
+end

data/spec/database.yml

@@ -0,0 +1,19 @@
+sqlite3:
+  adapter: sqlite3
+  database: deposit.sqlite3
+
+mysql:
+  adapter: mysql2
+  hostname: localhost
+  username: root
+  password:
+  database: deposit
+  charset: utf8
+  
+postgresql:
+  adapter: postgresql
+  hostname: localhost
+  username: postgres
+  password:
+  database: deposit
+  encoding: utf8

data/spec/deposit/deposit_migration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+# Generators are not automatically loaded by Rails
+require File.expand_path('../../../lib/generators/deposit_migration/deposit_migration_generator', __FILE__)
+
+describe DepositMigrationGenerator do
+  # TODO: undefined method `destination'?
+
+  # # Tell the generator where to put its output (what it thinks of as Rails.root)
+  # destination File.expand_path("../../../../../tmp", __FILE__)
+
+  # before do
+  #   prepare_destination
+  # end
+
+  # describe 'no arguments' do
+  #   before { run_generator  }
+
+  #   describe 'db/migrate/acts_as_taggable_on_migration.rb' do
+  #     subject { file('db/migrate/acts_as_taggable_on_migration.rb') }
+  #     it { should be_a_migration }
+  #   end
+  # end
+end

data/spec/deposit/deposit_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe :Deposit do 
+  before do 
+    @e = DepositableModel.create
+  end
+
+  specify do 
+    @e.load_deposit(:empty).should == nil
+
+    @e.save_deposit(:array, [1,2,3]) == true
+    @e.load_deposit(:array).should == [1,2,3]
+
+    @e.save_deposit(:hash, {a: 12}).should == true
+    @e.load_deposit(:hash).should == {a: 12}
+  end
+end

data/spec/models.rb

@@ -0,0 +1,3 @@
+class DepositableModel < ActiveRecord::Base
+  acts_as_depositable
+end

data/spec/spec_helper.rb

@@ -0,0 +1,88 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+require 'logger'
+
+begin
+  require "rubygems"
+  require "bundler"
+
+  # Set up load paths for all bundled gems
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run \`bundlee install\`?"
+end
+
+Bundler.require
+require File.expand_path('../../lib/deposit', __FILE__)
+require 'deposit'
+
+require 'ammeter/init'
+
+# set adapter to use, default is sqlite3
+# to use an alternative adapter run => rake spec DB='postgresql'
+db_name = ENV['DB'] || 'sqlite3'
+database_yml = File.expand_path('../database.yml', __FILE__)
+
+if File.exists?(database_yml)
+  active_record_configuration = YAML.load_file(database_yml)
+  
+  ActiveRecord::Base.configurations = active_record_configuration
+  config = ActiveRecord::Base.configurations[db_name]
+  
+  begin
+    ActiveRecord::Base.establish_connection(db_name)
+    ActiveRecord::Base.connection
+  rescue
+    case db_name
+    when /mysql/      
+      ActiveRecord::Base.establish_connection(config.merge('database' => nil))
+      ActiveRecord::Base.connection.create_database(config['database'],  {:charset => 'utf8', :collation => 'utf8_unicode_ci'})
+    when 'postgresql'
+      ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+      ActiveRecord::Base.connection.create_database(config['database'], config.merge('encoding' => 'utf8'))
+    end
+    
+    ActiveRecord::Base.establish_connection(config)
+  end
+  
+  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+  ActiveRecord::Base.default_timezone = :utc
+  
+  ActiveRecord::Base.silence do
+    ActiveRecord::Migration.verbose = false
+
+    ActiveRecord::Schema.define version: 0 do
+      create_table :depositable_models, force: true do |t|
+        t.column :name, :string
+      end
+
+      create_table :deposit_slots, force: true do |t|
+        t.integer :item_id
+        t.string :item_type
+
+        t.string :key
+        t.text :data
+
+        t.timestamps
+      end
+
+      add_index :deposit_slots, [:item_id, :item_type, :key]
+    end
+
+    class DepositableModel < ActiveRecord::Base
+      acts_as_depositable
+    end
+  end
+  
+else
+  raise "Please create #{database_yml} first to configure your database. Take a look at: #{database_yml}.sample"
+end
+
+def clean_database!
+  models = [DepositableModel, Deposit::DepositSlot]
+  models.each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end
+
+clean_database!

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: deposit
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- linjunhalida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.8
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails plugin for saving additional data for model.
+email: linjunhalida@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- deposit.gemspec
+- lib/deposit.rb
+- lib/generators/deposit_migration/USAGE
+- lib/generators/deposit_migration/deposit_migration_generator.rb
+- lib/generators/deposit_migration/templates/migration.rb
+- spec/database.yml
+- spec/deposit/deposit_migration_spec.rb
+- spec/deposit/deposit_spec.rb
+- spec/models.rb
+- spec/spec_helper.rb
+homepage: https://github.com/halida/deposit
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Saving additional data for rails model.
+test_files: []