draftsman 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c75a20681563bfa82fba2f109838a5fb2688d043
-  data.tar.gz: 7f43cc039a9d07048fbdfc04cfd9f8c5ff764ce1
+  metadata.gz: c32bf1dbb24a4fea24cf03abe3c859a965a46cae
+  data.tar.gz: c46acc2bf65572dc84890b66326d98a4d01c8c51
 SHA512:
-  metadata.gz: 032096c7295407be9a2ba40e8ccd51e5e595279fef880d0011145867c32ccf3df60e5a47282afeacc7a5b5022745cf0531d96b03cb34a43931577cdcbeabad85
-  data.tar.gz: 6eb88502e4c4f176cb85660614597eea419425d14a35ff2390ae0f6b9a71718fd7d84adce866f82ab904f605c9c82cd967881d2a037ac932a43376bef539544f
+  metadata.gz: d25357aecfb9899638710cebb6950b05f7f1359b8151f62a2965b3eaf358ec71e7ad1bc27a347eba321ce97ea3999803ba387c3bfc817703c5eb8b62de1f24cb
+  data.tar.gz: 3c0f135e0d1d5920344e879b8dbb26ede69ae6a6ee8c0dec43d5f5df8a4e6bfab251821b2c9daac3de8b2691f7f529b575a75bfdbe80b5febfec414aaf88a902

data/.gitignore

@@ -8,3 +8,4 @@ pkg/*
 spec/dummy/tmp/
 spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
+Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.2
+ruby-2.2.1

data/CHANGELOG.md

@@ -1,16 +1,22 @@
 # CHANGELOG
 
+## 0.3.2 - April 6, 2015
+
+-  Fixed [#8](https://github.com/liveeditor/draftsman/issues/8) - Update specs to use new community standards
+-  Fixed [#9](https://github.com/liveeditor/draftsman/issues/9) - Sinatra extension should not use Sinatra base namespace
+-  Fixed [#12](https://github.com/liveeditor/draftsman/issues/12) - JSON::ParserError when draft_destroying a widget which was just created
+
 ## 0.3.1 - August 14, 2014
 
--  Commit [aae737fcdf](https://github.com/live-editor/draftsman/commit/aae737fcdf48604bc480b1c9c141bf642c0f581c) - `skip` option not persisting skipped values correctly
+-  Commit [aae737f](https://github.com/live-editor/draftsman/commit/aae737fcdf48604bc480b1c9c141bf642c0f581c) - `skip` option not persisting skipped values correctly
 
 ## 0.3.0 - July 29, 2014
 
--  Commit [1e2a59f678](https://github.com/live-editor/draftsman/commit/1e2a59f678cc4d88222dfc1976d564b5649cd329) - Add support for PostgreSQL JSON data type for `object`, `object_changes`, and `previous_draft` columns.
+-  Commit [1e2a59f](https://github.com/live-editor/draftsman/commit/1e2a59f678cc4d88222dfc1976d564b5649cd329) - Add support for PostgreSQL JSON data type for `object`, `object_changes`, and `previous_draft` columns.
 
 ## v0.2.1 - June 28, 2014
 
--  Commit [dbc6c83abb](https://github.com/live-editor/draftsman/commit/dbc6c83abbea5211f67ad883f4a2d18a9f5ac181) - Reifying a record that was drafted for destruction uses data from a drafted update before that if that's what happened.
+-  Commit [dbc6c83](https://github.com/live-editor/draftsman/commit/dbc6c83abbea5211f67ad883f4a2d18a9f5ac181) - Reifying a record that was drafted for destruction uses data from a drafted update before that if that's what happened.
 
 ## v0.2.0 - June 3, 2014
 

data/README.md

@@ -1,4 +1,4 @@
-# Draftsman v0.3.1 (alpha)
+# Draftsman v0.3.2 (alpha)
 
 Draftsman is a Ruby gem that lets you create draft versions of your database records. If you're developing a system in
 need of simple drafts or a publishing approval queue, then Draftsman just might be what you need.

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

data/bin/erubis

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('draftsman', 'erubis')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('draftsman', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('draftsman', 'ldiff')

data/bin/nokogiri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'nokogiri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('draftsman', 'nokogiri')

data/bin/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('draftsman', 'rackup')

data/bin/rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rails' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('railties', 'rails')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('draftsman', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'thor')

data/bin/tilt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tilt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tilt', 'tilt')

data/draftsman.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.version       = Draftsman::VERSION
   s.summary       = "Create draft versions of your ActiveRecord models' data. Works with Ruby on Rails and Sinatra."
   s.description   = s.summary
-  s.homepage      = 'https://github.com/live-editor/draftsman'
+  s.homepage      = 'https://github.com/liveeditor/draftsman'
   s.authors       = ['Chris Peters']
   s.email         = 'chris@minimalorange.com'
   s.license       = 'MIT'
@@ -18,12 +18,10 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activerecord', ['>= 3.0', '< 5.0']
 
-  s.add_development_dependency 'capybara'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'railties', ['>= 3.0', '< 5.0']
   s.add_development_dependency 'sinatra', '~> 1.0'
-  s.add_development_dependency 'rspec-rails'
-  s.add_development_dependency 'shoulda-matchers'
+  s.add_development_dependency 'rspec-rails', '3.2.1'
 
   # JRuby support for the test ENV
   if defined?(JRUBY_VERSION)

data/lib/draftsman/draft.rb

@@ -1,7 +1,7 @@
 class Draftsman::Draft < ActiveRecord::Base
   # Mass assignment (for <= ActiveRecord 3.x)
   if Draftsman.active_record_protected_attributes?
-    attr_accessible :item_type, :item_id, :event, :whodunnit, :object, :object_changes
+    attr_accessible :item_type, :item_id, :item, :event, :whodunnit, :object, :object_changes, :previous_draft
   end
 
   # Associations
@@ -32,6 +32,11 @@ class Draftsman::Draft < ActiveRecord::Base
     @object_changes_col_is_json ||= columns_hash['object_changes'].type == :json
   end
 
+  # Returns whether the `previous_draft` column is using the `json` type supported by PostgreSQL.
+  def self.previous_changes_col_is_json?
+    @previous_changes_col_is_json ||= columns_hash['object_changes'].type == :json
+  end
+
   def self.updates
     where :event => 'update'
   end
@@ -72,7 +77,7 @@ class Draftsman::Draft < ActiveRecord::Base
 
       associations.each do |association|
         association_class =
-          if association.polymorphic?
+          if association.options.key?(:polymorphic)
             my_item.send(association.foreign_key.sub('_id', '_type')).constantize
           else
             association.klass
@@ -136,7 +141,7 @@ class Draftsman::Draft < ActiveRecord::Base
 
       associations.each do |association|
         association_class =
-          if association.polymorphic?
+          if association.options.key?(:polymorphic)
             self.item.send(association.foreign_key.sub('_id', '_type')).constantize
           else
             association.klass
@@ -180,7 +185,11 @@ class Draftsman::Draft < ActiveRecord::Base
         attributes_to_change = attributes_to_change - ignore + ['published_at', "#{self.item.class.draft_association_name}_id"] - skip
 
         # Save without validations or callbacks
-        self.item.update_columns self.item.attributes.slice(*attributes_to_change)
+        self.item.attributes.slice(*attributes_to_change).each do |key, value|
+          self.item.send("#{key}=", value)
+        end
+        self.item.save(:validate => false)
+        
         self.item.reload
 
         # Destroy draft

data/lib/draftsman/frameworks/sinatra.rb

@@ -1,9 +1,11 @@
-module Sinatra
-  module Draftsman
+require 'active_support/core_ext/object' # provides the `try` method
+
+module Draftsman
+  module Sinatra
 
     # Register this module inside your Sinatra application to gain access to controller-level methods used by Draftsman
     def self.registered(app)
-      app.helpers Sinatra::Draftsman
+      app.helpers self
       app.before { set_draftsman_whodunnit }
     end
 
@@ -15,17 +17,20 @@ module Sinatra
     # Override this method in your controller to call a different
     # method, e.g. `current_person`, or anything you like.
     def user_for_draftsman
-      current_user if defined?(current_user)
+      return unless defined?(current_user)
+      ActiveSupport::VERSION::MAJOR >= 4 ? current_user.try!(:id) : current_user.try(:id)
+    rescue NoMethodError
+      current_user
     end
 
   private
 
     # Tells Draftsman who is responsible for any changes that occur.
     def set_draftsman_whodunnit
-      ::Draftsman.whodunnit = user_for_draftsman
+      ::Draftsman.whodunnit = user_for_draftsman if ::Draftsman.enabled?
     end
 
   end
 
-  register Sinatra::Draftsman if defined?(register)
+  ::Sinatra.register Draftsman::Sinatra if defined?(::Sinatra)
 end

data/lib/draftsman/model.rb

@@ -120,11 +120,6 @@ module Draftsman
         method_defined?(:draftsman_options)
       end
 
-      # Returns whether or not the included ActiveRecord can do `where.not(...)` style queries.
-      def where_not?
-        ActiveRecord::VERSION::STRING.to_f >= 4.0
-      end
-
       # Serializes attribute changes for `Draft#object_changes` attribute.
       def serialize_draft_attribute_changes(changes)
         # Don't serialize values before inserting into columns of type `JSON` on PostgreSQL databases.
@@ -183,6 +178,11 @@ module Draftsman
           end
         end
       end
+
+      # Returns whether or not the included ActiveRecord can do `where.not(...)` style queries.
+      def where_not?
+        ActiveRecord::VERSION::STRING.to_f >= 4.0
+      end
     end
 
     module InstanceMethods
@@ -231,7 +231,13 @@ module Draftsman
 
           # Stash previous draft in case it needs to be reverted later
           if self.draft?
-            data[:previous_draft] = Draftsman.serializer.dump(send(self.class.draft_association_name).attributes)
+            attrs = send(self.class.draft_association_name).attributes
+
+            data[:previous_draft] = if self.class.draft_class.previous_changes_col_is_json?
+              attrs
+            else
+              Draftsman.serializer.dump(attrs)
+            end
           end
 
           data = merge_metadata_for_draft(data)

data/lib/draftsman/version.rb

@@ -1,3 +1,3 @@
 module Draftsman
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/spec/controllers/informants_controller_spec.rb

@@ -1,27 +1,45 @@
 require 'spec_helper'
 
 # Tests controller `info_for_draftsman` method
-describe InformantsController do
+describe InformantsController, :type => :controller do
   let(:trashable) { Trashable.create!(:name => 'Bob') }
 
-  describe :create do
+  describe 'create' do
     before { post :create }
     subject { Draftsman::Draft.last }
-    its(:ip) { should eql '123.45.67.89' }
-    its(:user_agent) { should eql '007' }
+
+    it 'records `ip` from custom `info_for_draftsman`' do
+      expect(subject.ip).to eql '123.45.67.89'
+    end
+
+    it 'records `user_agent` from custom `info_for_draftsman`' do
+      expect(subject.user_agent).to eql '007'
+    end
   end
 
-  describe :update do
+  describe 'update' do
     before { put :update, :id => trashable.id }
     subject { Draftsman::Draft.last }
-    its(:ip) { should eql '123.45.67.89' }
-    its(:user_agent) { should eql '007' }
+
+    it 'records `ip` from custom `info_for_draftsman`' do
+      expect(subject.ip).to eql '123.45.67.89'
+    end
+
+    it 'records `user_agent` from custom `info_for_draftsman`' do
+      expect(subject.user_agent).to eql '007'
+    end
   end
 
-  describe :destroy do
+  describe 'destroy' do
     before { delete :destroy, :id => trashable.id }
     subject { Draftsman::Draft.last }
-    its(:ip) { should eql '123.45.67.89' }
-    its(:user_agent) { should eql '007' }
+
+    it 'records `ip` from custom `info_for_draftsman`' do
+      expect(subject.ip).to eql '123.45.67.89'
+    end
+
+    it 'records `user_agent` from custom `info_for_draftsman`' do
+      expect(subject.user_agent).to eql '007'
+    end
   end
 end

data/spec/controllers/users_controller_spec.rb

@@ -1,23 +1,32 @@
 require 'spec_helper'
 
-describe UsersController do
+describe UsersController, :type => :controller do
   let(:trashable) { Trashable.create!(:name => 'Bob') }
 
-  describe :create do
+  describe 'create' do
     before { post :create }
     subject { Draftsman::Draft.last }
-    its(:whodunnit) { should eql 'A User' }
+
+    it 'records user name via `user_for_draftsman`' do
+      expect(subject.whodunnit).to eql 'A User'
+    end
   end
 
-  describe :update do
+  describe 'update' do
     before { put :update, :id => trashable.id }
     subject { return Draftsman::Draft.last }
-    its(:whodunnit) { should eql 'A User' }
+
+    it 'records user name via `user_for_draftsman`' do
+      expect(subject.whodunnit).to eql 'A User'
+    end
   end
 
-  describe :destroy do
+  describe 'destroy' do
     before { delete :destroy, :id => trashable.id }
     subject { return Draftsman::Draft.last }
-    its(:whodunnit) { should eql 'A User' }
+
+    it 'records user name via `user_for_draftsman`' do
+      expect(subject.whodunnit).to eql 'A User'
+    end
   end
 end

data/spec/controllers/whodunnits_controller_spec.rb

@@ -1,24 +1,33 @@
 require 'spec_helper'
 
 # Tests the automatic usage of `current_user` as the `whodunnit` attribute on the draft object
-describe WhodunnitsController do
+describe WhodunnitsController, :type => :controller do
   let(:trashable) { Trashable.create!(:name => 'Bob') }
 
-  describe :create do
+  describe 'create' do
     before { post :create }
     subject { Draftsman::Draft.last }
-    its(:whodunnit) { should eql "153" }
+
+    it 'records `current_user` via `user_for_draftsman' do
+      expect(subject.whodunnit).to eql "153"
+    end
   end
 
-  describe :update do
+  describe 'update' do
     before { put :update, :id => trashable.id }
     subject { Draftsman::Draft.last }
-    its(:whodunnit) { should eql "153" }
+
+    it 'records `current_user` via `user_for_draftsman' do
+      expect(subject.whodunnit).to eql "153"
+    end
   end
 
-  describe :destroy do
+  describe 'destroy' do
     before { delete :destroy, :id => trashable.id }
     subject { Draftsman::Draft.last }
-    its(:whodunnit) { should eql "153" }
+
+    it 'records `current_user` via `user_for_draftsman' do
+      expect(subject.whodunnit).to eql "153"
+    end
   end
 end

data/spec/draftsman_spec.rb

@@ -1,19 +1,25 @@
 require 'spec_helper.rb'
 
 describe ::Draftsman do
-  describe 'Sanity Test' do
-    it { should be_a Module }
+  subject { ::Draftsman }
+
+  it 'passes our sanity test' do
+    expect(subject).to be_a Module
   end
 
   describe :whodunnit do
     before(:all) { ::Draftsman.whodunnit = 'foobar' }
-    # Clears out `source` before each test
-    its(:whodunnit) { should be_nil }
+
+    it 'clears out `whodunnit` before each test' do
+      expect(subject.whodunnit).to be_nil
+    end
   end
 
   describe :controller_info do
     before(:all) { ::Draftsman.controller_info = { foo: 'bar' } }
-    # Clears out `controller_info` before each test
-    its(:controller_info) { should == {} }
+
+    it 'clears out `controller_info` before each test' do
+      expect(subject.controller_info).to eql Hash.new
+    end
   end
 end