drafting 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94ccad0d128a76e1c1aa944da416b5cee2ceb0be
+  data.tar.gz: 4611668c5f7f0fb09625d805fd2ad3bff2bb5abd
+SHA512:
+  metadata.gz: 145c85f1ffcc5f7a9a1d24e219e88145c74a9a848337ad0d5a6349c8d12b7ded881538d21b44fbc7f1cacf2c62ae1c34984e6c7b35645b69bdc4b73d5efe7b9c
+  data.tar.gz: ad9209a1d0a2b713136854ae48bf809ce1df43b4d14a780d5862eb96f8b3ffd04598ede59d790235a53061463f6f9292dd75cf5ec29aa5ea648b18dc3ed04243

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Georg Ledermann
+
+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,50 @@
+# Drafting
+
+This Ruby gem enhances `ActiveRecord::Base` to save a draft version of the current instance.
+
+Remarkable:
+
+* The gem stores all the data in **one** separate table and does not need to modify the existing tables
+* It handles drafts for different models
+* It allows saving draft for an object which does not pass the validations
+* It uses marshaling, so associations and virtual attributes are saved, too
+* A draft is optionally linked to a given user, so every user can manage his own drafts (invisible for the other users)
+* A draft is optionally linked to a parent object. This helps showing existing drafts in a context (e.g. message drafts for a given topic)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'drafting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install drafting
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ledermann/drafting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Based on some code from the (probably) outdated gem [drafts](https://rubygems.org/gems/drafts) by Alexey Kuznetsov (@lxkuz)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "drafting"
+
+$LOAD_PATH.unshift(File.expand_path('..', File.dirname(__FILE__)))
+require 'lib/generators/drafting/migration/templates/migration.rb'
+require 'spec/support/spec_migration.rb'
+
+require 'spec/models/user'
+require 'spec/models/topic'
+require 'spec/models/message'
+require 'spec/models/page'
+require 'spec/models/tag'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+ActiveRecord::Base.configurations = YAML.load_file('spec/database.yml')
+ActiveRecord::Base.establish_connection(:sqlite)
+ActiveRecord::Migration.verbose = false
+
+DraftingMigration.up
+SpecMigration.up
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/drafting.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'drafting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "drafting"
+  spec.version       = Drafting::VERSION
+  spec.authors       = ["Georg Ledermann"]
+  spec.email         = ["mail@georg-ledermann.de"]
+
+  spec.summary       = %q{Save draft version of any ActiveRecord object}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/ledermann/drafting"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "coveralls"
+end

data/lib/drafting.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+require "drafting/version"
+require "drafting/base_class_methods"
+require "drafting/class_methods"
+require "drafting/instance_methods"
+require "drafting/draft"
+
+ActiveRecord::Base.extend Drafting::BaseClassMethods

data/lib/drafting/base_class_methods.rb

@@ -0,0 +1,29 @@
+module Drafting
+  module BaseClassMethods
+    ALLOWED_DRAFT_OPTION_KEYS = [ :parent ]
+
+    def has_drafts(options={})
+      raise ArgumentError unless options.is_a?(Hash)
+      raise ArgumentError unless options.keys.all? { |k| ALLOWED_DRAFT_OPTION_KEYS.include?(k) }
+
+      class_attribute :draft_parent
+
+      if options[:parent]
+        parent_class = self.reflect_on_all_associations(:belongs_to).find { |a| a.name == options[:parent] }.try(:klass)
+        raise ArgumentError unless parent_class
+
+        parent_class.class_eval do
+          has_many :drafts, :as => :parent, :dependent => :nullify
+        end
+
+        self.draft_parent = options[:parent]
+      end
+
+      include Drafting::InstanceMethods
+      extend Drafting::ClassMethods
+
+      attr_accessor :draft_id
+      after_create :clear_draft
+    end
+  end
+end

data/lib/drafting/class_methods.rb

@@ -0,0 +1,19 @@
+module Drafting
+  module ClassMethods
+    def from_draft(draft_or_id)
+      draft = draft_or_id.is_a?(Draft) ? draft_or_id : Draft.find(draft_or_id)
+      raise ArgumentError unless draft.target_type == name
+
+      target = draft.target_type.constantize.new
+      target.load_from_draft(draft.data)
+
+      target.send("#{draft_parent}=", draft.parent) if draft_parent
+      target.draft_id = draft.id
+      target
+    end
+
+    def drafts(user)
+      Draft.where(:user => user, :target_type => name)
+    end
+  end
+end

data/lib/drafting/draft.rb

@@ -0,0 +1,10 @@
+class Draft < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :parent, :polymorphic => true
+
+  validates_presence_of :data, :target_type
+
+  def restore
+    target_type.constantize.from_draft(self)
+  end
+end

data/lib/drafting/instance_methods.rb

@@ -0,0 +1,46 @@
+module Drafting
+  module InstanceMethods
+    def save_draft(user=nil)
+      return false unless self.new_record?
+
+      draft = Draft.find_by_id(self.draft_id) || Draft.new
+
+      draft.data = dump_to_draft
+      draft.target_type = self.class.name
+      draft.user = user
+      draft.parent = self.send(self.class.draft_parent) if self.class.draft_parent
+
+      result = draft.save
+      self.draft_id = draft.id if result
+      result
+    end
+
+    def update_draft(user, attributes)
+      with_transaction_returning_status do
+        assign_attributes(attributes)
+        save_draft(user)
+      end
+    end
+
+    # Override this two methods if you want to change the way to dump/load data
+    def dump_to_draft
+      Marshal.dump(instance_values)
+    end
+
+    def load_from_draft(string)
+      values = Marshal.load(string)
+
+      values.each do |name, value|
+        instance_variable_set("@#{name}", value)
+      end
+    end
+
+  private
+
+    def clear_draft
+      if draft = Draft.find_by_id(self.draft_id)
+        self.draft_id = nil if draft.destroy
+      end
+    end
+  end
+end

data/lib/drafting/version.rb

@@ -0,0 +1,3 @@
+module Drafting
+  VERSION = "0.1.0"
+end

data/lib/generators/drafting/migration/migration_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Drafting
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc 'Generates migration for Drafting'
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/drafting_migration'
+    end
+
+    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
+  end
+end

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

@@ -0,0 +1,17 @@
+class DraftingMigration < ActiveRecord::Migration
+  def self.up
+    create_table :drafts do |t|
+      t.string :target_type, :null => false
+      t.references :user
+      t.references :parent, :polymorphic => true, :index => true
+      t.binary :data, :limit => 16777215, :null => false
+      t.datetime :updated_at, :null => false
+    end
+
+    add_index :drafts, [:user_id, :target_type]
+  end
+
+  def self.down
+    drop_table :drafts
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: drafting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Georg Ledermann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: factory_girl
+  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: coveralls
+  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: ''
+email:
+- mail@georg-ledermann.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- drafting.gemspec
+- lib/drafting.rb
+- lib/drafting/base_class_methods.rb
+- lib/drafting/class_methods.rb
+- lib/drafting/draft.rb
+- lib/drafting/instance_methods.rb
+- lib/drafting/version.rb
+- lib/generators/drafting/migration/migration_generator.rb
+- lib/generators/drafting/migration/templates/migration.rb
+homepage: https://github.com/ledermann/drafting
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Save draft version of any ActiveRecord object
+test_files: []