drafting 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94ccad0d128a76e1c1aa944da416b5cee2ceb0be
-  data.tar.gz: 4611668c5f7f0fb09625d805fd2ad3bff2bb5abd
+  metadata.gz: 88b15d49a289bae4e3b54fd33020792a23c8383e
+  data.tar.gz: 3a23d7a0924d227f79df9dcdc2c486ab14763160
 SHA512:
-  metadata.gz: 145c85f1ffcc5f7a9a1d24e219e88145c74a9a848337ad0d5a6349c8d12b7ded881538d21b44fbc7f1cacf2c62ae1c34984e6c7b35645b69bdc4b73d5efe7b9c
-  data.tar.gz: ad9209a1d0a2b713136854ae48bf809ce1df43b4d14a780d5862eb96f8b3ffd04598ede59d790235a53061463f6f9292dd75cf5ec29aa5ea648b18dc3ed04243
+  metadata.gz: cc5a190a3a9d2219f8fd410bb7bfedce0128e21611812d63a1c3c5e07a532be390cf3d583e6e674e7321641ace0daf0e090d68f7d35647dad7918d863b8975e3
+  data.tar.gz: c0e3576d2e7b78b7042a9e7e0af119290ab3131e10585661de9bf35bbfdf3a512b35cef8380c22063bd851d8bc2abbccb6274925be619c1c4196f5fa939e7c83

data/README.md

@@ -2,14 +2,19 @@
 
 This Ruby gem enhances `ActiveRecord::Base` to save a draft version of the current instance.
 
-Remarkable:
+[![Build Status](https://travis-ci.org/ledermann/drafting.svg?branch=master)](https://travis-ci.org/ledermann/drafting)
+[![Code Climate](https://codeclimate.com/github/ledermann/drafting/badges/gpa.svg)](https://codeclimate.com/github/ledermann/drafting)
+[![Coverage Status](https://coveralls.io/repos/ledermann/drafting/badge.svg?branch=master)](https://coveralls.io/r/ledermann/drafting?branch=master)
+
+## Features
 
 * 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
+* It allows saving draft for an instance which does not pass the validations
+* A draft stores associations and virtual attributes, 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)
+* A draft is optionally linked to a parent instance. This helps showing existing drafts in a context (e.g. message drafts for a given topic)
+* Only 80 lines of code
 
 
 ## Installation
@@ -28,9 +33,62 @@ Or install it yourself as:
 
     $ gem install drafting
 
+Finally, generate and run the migration:
+
+    $ rails g drafting:migration
+    $ rake db:migrate
+
+
 ## Usage
 
-TODO: Write usage instructions here
+### Simple example
+
+```ruby
+class Message < ActiveRecord::Base
+  has_drafts
+end
+
+message = Message.new content: "Let's start with a simple example."
+message.save_draft(current_user)
+
+# Time passes ...
+
+draft = Message.drafts(current_user).first
+message = draft.restore
+message.save!
+```
+
+### Linking to parent instance
+
+```ruby
+class Topic < ActiveRecord::Base
+  has_many :messages
+end
+
+class Message < ActiveRecord::Base
+  belongs_to :topic
+  has_drafts parent: :topic
+end
+
+topic = Topic.create! title: 'World domination'
+message = topic.messages.build content: 'First step: Get some coffee.'
+message.save_draft(current_user)
+
+# Time passes ...
+
+draft = topic.drafts(current_user).first
+message = draft.restore
+message.save!
+```
+
+### Hints
+
+* `save_draft` is allowed only if the instance is not persisted yet
+* Doing `save_draft` overwrites a previous draft (if there is one)
+* After doing a `save`, the draft (if there is one) will be deleted
+* The `user` argument can be nil if you don't want to distinguish between multiple users
+* Saving draft stores the data via `Marshal.dump` and `Marshal.load`. If you don't like this or need some customization, you can override the instance methods `dump_to_draft` and `load_from_draft` (see source)
+
 
 ## Development
 
@@ -38,6 +96,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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.
@@ -47,4 +106,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/lederm
 
 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)
+Based on some code from the outdated gem [drafts](https://rubygems.org/gems/drafts). Used with kind permission of Alexey Kuznetsov (@lxkuz).

data/lib/drafting/base_class_methods.rb

@@ -12,8 +12,10 @@ module Drafting
         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
+        unless parent_class.method_defined? :drafts
+          parent_class.send :define_method, :drafts do |user|
+            Draft.where(:user => user, :parent => self)
+          end
         end
 
         self.draft_parent = options[:parent]

data/lib/drafting/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drafting
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-03 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord