orientea 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7484f4d726dde987d88c0a184178b1a7930bc20a
+  data.tar.gz: 002bfccb56b3144f14067f18db59277bc79dc38b
+SHA512:
+  metadata.gz: 14c837bda49e91409d2ed3243467da198cca945e334ffdc4b8c8308c63fbc4e8c23f50a623ed71e87a35252d6dd03139c2234d9fdb961a3e1ea928a406e99bde
+  data.tar.gz: 4be3d9c0664aa805348b0de0432ff7e127ac472b418172aaa2858bdc7a9ce45f4338b117ee545d729421dd4f8defb3dabc2ce1569b455a3dffab8b416b901c6d

data/.document

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "activerecord"
+gem "pg"
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'awesome_print'
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.3.5"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov"
+  gem 'rspec'
+  # gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,93 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (1.6.0)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.10)
+    awesome_print (1.1.0)
+    builder (3.2.2)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.4)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pg (0.15.1)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.3)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.4)
+    shoulda-matchers (2.2.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  awesome_print
+  bundler (>= 1.3.5)
+  jeweler (~> 1.8.4)
+  pg
+  rdoc (~> 3.12)
+  rspec
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Vincent Zhu
+
+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,4 @@
+orientea
+========
+
+One Command Pattern Implementation For Ruby with ActiveRecord

data/README.rdoc

@@ -0,0 +1,27 @@
+= Orientea,  one command pattern for active record. 
+
+This is one command pattern implementation for ruby. Designed to use with rails (ActiveRecord).
+You can store the command object , perform it by action method , or undo it by undo method.
+Note: this gem use postgresql with hstore extension.
+
+@record = Record.new
+create_command = Orientea::CreatingCommand.build(@record)  // would build and save the command
+@record.name = "changed name"
+change_command = Orientea::ChangingCommand.build(@record)  
+change_command.action // would apply the changes
+change_command.undo // would discard the changes
+== Contributing to orientea
+ 
+* 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) 2013 Vincent Zhu. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# 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 = "orientea"
+  gem.homepage = "http://github.com/vincent/orientea"
+  gem.license = "MIT"
+  gem.summary = %Q{Command Pattern Implementation for easy use with rails}
+  gem.description = %Q{Command Pattern Implementation for easy use with rails}
+  gem.email = "zhu1230@gmail.com"
+  gem.authors = ["Vincent Zhu"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "orientea #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/orientea/changing_command.rb

@@ -0,0 +1,47 @@
+require 'orientea/command.rb'
+module Orientea
+  class ChangingCommand < Orientea::Command
+
+    def self.build(record)
+      command = self.new
+      command.data = Hash.new
+      command.data['cls_str'] = record.class.to_s
+      command.data['cls_id'] = record.id
+      command.data['changes'] = record.changes.to_json
+      command.save!
+      command
+    end
+
+    action do
+      cls = self.data['cls_str'].constantize
+      id = self.data['cls_id']
+      object = cls.find(id)
+      JSON.load(self.data['changes']).each do |key, value|
+        object.send("#{key}=", value.last)
+      end
+      if object.save
+        self.done = true
+        self.save
+      end
+    end
+
+    undo do
+      cls = self.data['cls_str'].constantize
+      id = self.data['cls_id']
+      object = cls.find(id)
+      JSON.load(self.data['changes']).each do |key, value|
+        object.send("#{key}=", value.first)
+      end
+      if object.save
+        self.done = false
+        self.save
+      end
+    end
+
+    # persist do
+    #   self.data = @record.attributes
+    #   self.data['changes'] = @record.class.to_s
+    # end
+
+  end
+end

data/lib/orientea/command.rb

@@ -0,0 +1,14 @@
+module Orientea
+  class Command < ActiveRecord::Base
+    self.table_name = :orientea_commands
+    attr_accessor :done, :data
+
+    def self.action(&block)
+      define_method(:action, &block)
+    end
+
+    def self.undo(&block)
+      define_method(:undo, &block)
+    end
+  end
+end

data/lib/orientea/creating_command.rb

@@ -0,0 +1,38 @@
+require 'orientea/command.rb'
+module Orientea
+  class CreatingCommand < Orientea::Command
+
+    def self.build(record)
+      command = self.new
+      command.data = Hash.new
+      command.data['changes'] = record.attributes.to_json
+      command.data['cls_str'] = record.class.to_s
+      command.save!
+      command
+    end
+
+    action do
+      cls = self.data['cls_str'].constantize
+      new_object = cls.new(JSON.load(self.data['changes']))
+      if new_object.save
+        self.data['cls_id'] = new_object.id
+        self.data_will_change!
+        self.done = true
+        self.save
+      end
+    end
+
+    undo do
+      cls = self.data['cls_str'].constantize
+      cls.find(self.data['cls_id']).destroy
+      self.done = false
+      self.save
+    end
+
+    # persist do
+    #   self.data = @record.attributes
+    #   self.data['cls_str'] = @record.class.to_s
+    # end
+
+  end
+end

data/lib/orientea/generators/command_generator.rb

@@ -0,0 +1,6 @@
+class CommandGenerator < Rails::Generators::NamedBase 
+  source_root File.expand_path('../templates', __FILE__)  
+  def create_migration
+    migration_template 'create_command.rb', 'db/migrate/create_command_table.rb'
+  end
+end

data/lib/orientea.rb

@@ -0,0 +1,6 @@
+require 'active_record'
+require "orientea/changing_command"
+require "orientea/creating_command"
+module Orientea
+  VERSION = 1.0
+end

data/spec/changing_command_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Orientea::ChangingCommand do
+  include_context 'shared setup and clean'
+
+  before(:each) do
+    @customer = Customer.create(attr_name: 'vincent', attr_gender: 'male', attr_address: 'Nanjing')  
+  end
+  it "should work correctly with action" do
+    @customer.attr_name = 'Derek'
+    command = Orientea::ChangingCommand.build(@customer)
+    expect(command.done).to be_false
+    expect{
+      command.action
+    }.to change{Customer.first.attr_name}.from('vincent').to('Derek')
+    expect(command.done).to be_true
+  end
+
+  it "should save the command object" do
+    expect{Orientea::ChangingCommand.build(@customer)}.to change{Orientea::ChangingCommand.count}.by(1)
+  end
+
+  it "should work correctly with undo" do
+    @customer.attr_name = 'Derek'
+    command = Orientea::ChangingCommand.build(@customer)
+    command.action
+    expect{command.undo}.to change{Customer.first.attr_name}.from('Derek').to('vincent')
+  end
+end

data/spec/creating_command_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Orientea::CreatingCommand do
+  include_context 'shared setup and clean'
+
+  before(:each) do
+    @customer = Customer.new
+    @customer.attr_name = 'my name'
+    @customer.attr_gender = 'male'
+    @customer.attr_address = 'Nanjing'
+  end
+  it "action should work correctly with CreatingCommand" do
+    expect{
+      command = Orientea::CreatingCommand.build(@customer)
+      command.save
+      command.action
+    }.to change{Customer.count}.from(0).to(1)
+  end
+
+  it "should save the command object" do
+    expect{Orientea::CreatingCommand.build(@customer)}.to change{Orientea::CreatingCommand.count}.by(1)
+  end
+
+  it "undo should work correctly" do
+    command = Orientea::CreatingCommand.build(@customer)
+    command.save
+    command.action
+    expect{command.undo}.to change{Customer.count}.from(1).to(0)
+  end
+
+end

data/spec/shared_setup.rb

@@ -0,0 +1,38 @@
+shared_context 'shared setup and clean' do
+   before(:each) do
+    ActiveRecord::Base.establish_connection(
+      adapter: 'postgresql',
+      host: 'localhost',
+      port: 5432,
+      encoding: 'unicode',
+      username: 'postgres',
+      password: ''
+    )
+    ActiveRecord::Migration.class_eval do
+      execute "CREATE EXTENSION IF NOT EXISTS hstore"
+      unless ActiveRecord::Base.connection.table_exists?(:customers)
+         create_table :customers do |t|
+            t.string :attr_name
+            t.string :attr_address
+            t.string :attr_gender
+         end
+      end
+      unless ActiveRecord::Base.connection.table_exists?(:orientea_commands)
+         create_table :orientea_commands do |t|
+           t.hstore :data
+           t.boolean :done
+           t.string :type
+         end
+      end
+    end
+
+    Customer = Class.new(ActiveRecord::Base) unless defined? Customer
+  end
+
+  after(:each) do
+    ActiveRecord::Migration.class_eval do
+      drop_table :customers
+      drop_table :orientea_commands
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  require 'orientea'
+  require 'awesome_print'
+  require "shared_setup"
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'orientea'
+
+class Test::Unit::TestCase
+end

data/test/test_orientea.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestOrientea < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: orientea
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vincent Zhu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command Pattern Implementation for easy use with rails
+email: zhu1230@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/.DS_Store
+- lib/orientea.rb
+- lib/orientea/.DS_Store
+- lib/orientea/changing_command.rb
+- lib/orientea/command.rb
+- lib/orientea/creating_command.rb
+- lib/orientea/generators/command_generator.rb
+- lib/orientea/templates/create_command.rb
+- spec/changing_command_spec.rb
+- spec/creating_command_spec.rb
+- spec/shared_setup.rb
+- spec/spec_helper.rb
+- test/helper.rb
+- test/test_orientea.rb
+homepage: http://github.com/vincent/orientea
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Command Pattern Implementation for easy use with rails
+test_files: []