act_as_releasable 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in act_as_releasable.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})  { |m| "spec" }   # { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gregório Kusowski
+
+MIT License
+
+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,29 @@
+# ActAsReleasable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'act_as_releasable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install act_as_releasable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/act_as_releasable.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/act_as_releasable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gregório Kusowski"]
+  gem.email         = ["gregorio.kusowski@gmail.com"]
+  gem.description   = %q{Make your models work with a release candidate that must be approved}
+  gem.summary       = %q{wip}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "act_as_releasable"
+  gem.require_paths = ["lib"]
+  gem.version       = ActAsReleasable::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "factory_girl"
+  gem.add_development_dependency "sqlite3"
+  gem.add_dependency "activesupport"
+  gem.add_dependency "activemodel"
+  gem.add_dependency "activerecord"
+end

data/lib/act_as_releasable/models.rb

@@ -0,0 +1,30 @@
+require 'base64'
+
+module Proposal
+
+  def self.included(receiver)
+    receiver.belongs_to :item, :polymorphic => true
+    receiver.validates_presence_of :item_id, :item_type, :candidate_data
+
+    receiver.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+    def candidate_attributes
+      ActiveSupport::JSON.decode Marshal.load(Base64.decode64(candidate_data))
+    end
+    def candidate_attributes=(candidate_attributes)
+      self.candidate_data = Base64.encode64(Marshal.dump(candidate_attributes.to_json))
+    end
+  end
+
+end
+
+class ReleasableCandidate < ActiveRecord::Base
+  include Proposal
+end
+
+class ReleasableCandidateItem < ActiveRecord::Base
+  include Proposal
+  validates_presence_of :collection_name
+end

data/lib/act_as_releasable/version.rb

@@ -0,0 +1,3 @@
+module ActAsReleasable
+  VERSION = "0.0.1"
+end

data/lib/act_as_releasable.rb

@@ -0,0 +1,79 @@
+require "act_as_releasable/version"
+require "act_as_releasable/models"
+
+module ActAsReleasable
+  module ClassMethods
+    def act_as_releasable(options = {})
+      send :include, InstanceMethods
+
+      class_attribute :releasable_collections
+      self.releasable_collections = (options[:collections] || [])
+
+      has_one :releasable_candidate, :as => :item
+      unless self.releasable_collections.empty?
+        has_many :releasable_candidate_items, :as => :item
+      end
+
+    end
+  end
+
+  module InstanceMethods
+    def release_version!
+      # Clean-up of the official record
+      self.releasable_collections.each do |collection|
+        send(collection).destroy_all
+      end
+
+      # Updating attributes
+      self.attributes = releasable_candidate.candidate_attributes
+      releasable_candidate_items.each do |candidate_item|
+        send(candidate_item.collection_name).build candidate_item.candidate_attributes
+      end
+
+      # Destroying prototype data
+      releasable_candidate.destroy if releasable_candidate.present?
+      releasable_candidate_items.destroy_all
+
+      save!
+    end
+
+    def release_candidate
+      clone.tap do
+        self.releasable_collections.each do |collection|
+          send(collection).clear
+        end
+        self.attributes = releasable_candidate.try(:candidate_attributes) || {}
+        releasable_candidate_items.each do |candidate_item|
+          send(candidate_item.collection_name).build candidate_item.candidate_attributes
+        end
+      end
+    end
+
+    def generate_new_candidate
+      if valid?
+        # Destroying prototype data
+        releasable_candidate.destroy if releasable_candidate.present?
+        releasable_candidate_items.destroy_all
+
+        # Creating new prototype data
+        create_releasable_candidate! :candidate_attributes => attributes
+        self.releasable_collections.each do |collection|
+          send(collection).each do |collection_item|
+            unless collection_item.marked_for_destruction?
+              releasable_candidate_items.create! ({:candidate_attributes => collection_item.attributes, :collection_name => collection})
+            end
+          end
+        end
+      end
+    end
+
+  end
+
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActAsReleasable
+end

data/lib/generators/act_as_releasable/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+module ActAsReleasable
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'Generates the Releasable Candidates migrations.'
+
+    def create_migration_file
+      %w/create_releasable_candidates create_releasable_candidate_items/.each do |f|
+        begin
+          migration_template "#{f}.rb", "db/migrate/#{f}.rb"
+        rescue Rails::Generators::Error => e
+          puts e.message
+        end
+      end
+    end
+  end
+end

data/lib/generators/act_as_releasable/templates/create_releasable_candidate_items.rb

@@ -0,0 +1,13 @@
+class CreateReleasableCandidateItems < ActiveRecord::Migration
+  def change
+    create_table :releasable_candidate_items do |t|
+      t.string :item_type, :null => false
+      t.integer :item_id,   :null => false
+      t.text :candidate_data
+      t.string :collection_name
+      t.timestamps
+    end
+    add_index :releasable_candidate_items, :item_id
+    add_index :releasable_candidate_items, [:item_type, :item_id]
+  end
+end

data/lib/generators/act_as_releasable/templates/create_releasable_candidates.rb

@@ -0,0 +1,12 @@
+class CreateReleasableCandidates < ActiveRecord::Migration
+  def change
+    create_table :releasable_candidates do |t|
+      t.string :item_type,      :null => false
+      t.integer :item_id,       :null => false
+      t.text :candidate_data
+      t.timestamps
+    end
+    add_index :releasable_candidates, :item_id
+    add_index :releasable_candidates, [:item_type, :item_id]
+  end
+end

data/spec/candidate_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe "the creation of a release candidate" do
+
+  let (:phantoms) { create(:phantoms) }
+  let (:jazz_all_stars) { create(:jazz_all_stars) }
+
+  context "when dealing with simple data" do
+
+    let (:new_name) { "Scooby-doo is around!" }
+
+    before do
+      phantoms.name = new_name
+      phantoms.generate_new_candidate
+    end
+
+    it "doesn't update any original attribute" do
+      phantoms.reload.name.should eq "Phantoms"
+    end
+
+    it "presents the changes on a transient model" do
+      phantoms.release_candidate.name.should eq new_name
+    end
+
+  end
+
+  context "when dealing with collections" do
+
+    context "on removal" do
+
+      before do
+        first_player = jazz_all_stars.players.first
+        first_player.mark_for_destruction
+        jazz_all_stars.generate_new_candidate
+      end
+
+      it "keeps a entire new collection, so deleted data is kept for release candidate" do
+        jazz_all_stars.release_candidate.should have(2).players
+      end
+
+      it "doesn't remove any item from database" do
+        jazz_all_stars.reload.should have(3).players
+      end
+
+    end
+
+    context "on addition" do
+
+      before do
+        phantoms.players.build attributes_for(:gasper)
+        phantoms.generate_new_candidate
+      end
+
+      it "adds the items to the release canditate" do
+        phantoms.release_candidate.should have(1).player
+      end
+
+      it "keeps approved items on the database record" do
+        phantoms.reload.should have(:no).players
+      end
+
+    end
+
+    context "on change" do
+
+      before do
+        jazz_all_stars.players.each do |player|
+          player.name = "Mr. #{player.name}"
+        end
+        jazz_all_stars.generate_new_candidate
+      end
+
+      it "keeps non-released data on the database record" do
+        Player.where("name like ?", 'Mr.%').should be_empty
+      end
+
+      it "makes all changes available on the release candidate" do
+        jazz_all_stars.release_candidate.players.each do |player|
+          player.name.should match /Mr\./
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/db/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: ":memory:"

data/spec/db/schema.rb

@@ -0,0 +1,33 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :releasable_candidate_items do |t|
+    t.string :item_type, :null => false
+    t.integer :item_id,   :null => false
+    t.text :candidate_data
+    t.string :collection_name
+    t.timestamps
+  end
+
+  create_table :releasable_candidates do |t|
+    t.string :item_type,      :null => false
+    t.integer :item_id,       :null => false
+    t.text :candidate_data
+    t.timestamps
+  end
+
+  create_table :teams do |t|
+    t.string :name
+  end
+
+  create_table :players do |t|
+    t.string :name
+    t.integer :skill_level
+    t.integer :team_id
+  end
+
+  add_index :releasable_candidate_items, :item_id
+  add_index :releasable_candidate_items, [:item_type, :item_id]
+  add_index :releasable_candidates, :item_id
+  add_index :releasable_candidates, [:item_type, :item_id]
+
+end

data/spec/factories/jazz_all_stars.rb

@@ -0,0 +1,20 @@
+FactoryGirl.define do
+  factory :jazz_all_stars, :class => Team do
+    name "Jazz All-Stars"
+    players do |player|
+      [player.association(:coltrane), player.association(:miles), player.association(:louis)]
+    end
+  end
+  factory :default_player, :class => Player do
+    skill_level { rand(10) }
+  end
+  factory :coltrane, :parent => :default_player do
+    name "John Coltrane"
+  end
+  factory :miles, :parent => :default_player do
+    name "Miles Davis"
+  end
+  factory :louis, :parent => :default_player do
+    name "Louis Armstrong"
+  end
+end

data/spec/factories/phantoms.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :phantoms, :class => Team do
+    name "Phantoms"
+  end
+  factory :gasper, :class => Player do
+    name "Gasper"
+    skill_level { rand(10) }
+  end
+end

data/spec/release_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe "the release of a candidate" do
+
+  let (:phantoms) { create(:phantoms) }
+  let (:jazz_all_stars) { create(:jazz_all_stars) }
+
+  let (:new_name) { "Phantoms All-Stars" }
+
+  it "updates" do
+    phantoms.name = new_name
+    phantoms.generate_new_candidate
+
+    phantoms.reload.name.should_not == new_name
+    phantoms.release_version!
+    phantoms.reload.name.should == new_name
+  end
+
+  it "add items" do
+    phantoms.players.build attributes_for(:gasper)
+    phantoms.generate_new_candidate
+
+    expect do
+      phantoms.release_version!
+    end.to change(Player, :count).by(1)
+  end
+
+  it "remove items" do
+    jazz_all_stars.players.first.mark_for_destruction
+    jazz_all_stars.generate_new_candidate
+
+    expect do
+      jazz_all_stars.release_version!
+    end.to change(Player, :count).by(-1)
+  end
+
+  it "updates items" do
+    captain = jazz_all_stars.players.first
+    original_name = captain.name
+    captain_name = "Captain #{original_name}"
+    captain.name = captain_name
+    jazz_all_stars.generate_new_candidate
+
+    captain.reload.name.should == original_name
+    jazz_all_stars.release_version!
+    released_captain = jazz_all_stars.reload.players.detect { |player| player.name.starts_with? 'Captain' }
+    released_captain.name.should == captain_name
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+
+require 'factory_girl'
+require 'active_support'
+require 'active_model'
+require 'active_record'
+
+ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(File.dirname(__FILE__) + "/db/database.yml")).result)
+ActiveRecord::Base.establish_connection("sqlite3")
+ActiveRecord::Migration.verbose = false
+load(File.join(File.dirname(__FILE__), "db", "schema.rb"))
+
+require 'act_as_releasable'
+require 'support/models'
+require 'factories/jazz_all_stars'
+require 'factories/phantoms'
+
+# Require this file using `require "spec_helper"` to ensure that it is only
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.include FactoryGirl::Syntax::Methods
+
+  config.order = 'random'
+
+  config.after do
+    [ReleasableCandidateItem, ReleasableCandidate, Team, Player].each(&:destroy_all)
+  end
+end
+

data/spec/support/models.rb

@@ -0,0 +1,11 @@
+class Team < ActiveRecord::Base
+  has_many :players
+  validates_presence_of :name
+
+  act_as_releasable :collections => [:players]
+end
+
+class Player < ActiveRecord::Base
+  belongs_to :team
+  validates_presence_of :name, :skill_level
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: act_as_releasable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gregório Kusowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: 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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make your models work with a release candidate that must be approved
+email:
+- gregorio.kusowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- act_as_releasable.gemspec
+- lib/act_as_releasable.rb
+- lib/act_as_releasable/models.rb
+- lib/act_as_releasable/version.rb
+- lib/generators/act_as_releasable/install_generator.rb
+- lib/generators/act_as_releasable/templates/create_releasable_candidate_items.rb
+- lib/generators/act_as_releasable/templates/create_releasable_candidates.rb
+- spec/candidate_spec.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/factories/jazz_all_stars.rb
+- spec/factories/phantoms.rb
+- spec/release_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: wip
+test_files:
+- spec/candidate_spec.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/factories/jazz_all_stars.rb
+- spec/factories/phantoms.rb
+- spec/release_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb