archivable 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d44e5bc4b028fa7d6ac216051693c1ecf972d1eb
-  data.tar.gz: 1e5453096684c7f2260a1098307018fae11e9f80
+  metadata.gz: 4fc7307d09a886e09d22380e036677cde86d644b
+  data.tar.gz: 96fea8d4bf70912f24cdb699ffd51af2d7541b11
 SHA512:
-  metadata.gz: a779492544bbc49bc9fce1800c2b305a2dc1473ee7e54e398176bcb8d8a5c21cac51caa1933315d239c2632da93fefdd29ed29dc5eb9e430253d1b5327623d8a
-  data.tar.gz: 72e4e0c6327ed264e14acc2e4ef4ef96a73bcd7ca186a1a114c0dec8db4182a61f3ccd498bd6d833f1baef89e3c08f3fcecac893f8e6ef1f7b490474a9d5c547
+  metadata.gz: 5ae7cebf05e9fda03dd208fddadd4b399d54392e33a742fcea648b83867367d4c0bc1d22142693166ed4593e127d329ec6f66bffa5277842627281d0caac2d91
+  data.tar.gz: 474d8a2c42be8be8a7b78cc547fc55fffdace91f486f8e8bcc01fb2de1443240cb41448e9862a4dbb0fd16e456a6dbabaf902c4ecf2933b88b4e57dcfcc2c5c5

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+
 notifications:
   email:
     - johnotander@gmail.com

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 John Otander
+Copyright (c) 2014-2015 John Otander
 
 MIT License
 

data/README.md

@@ -2,27 +2,114 @@
 
 [![Build Status](https://travis-ci.org/johnotander/archivable.svg?branch=master)](https://travis-ci.org/johnotander/archivable)
 
-_Currently under development._
+Archive your Rails models rather than delete them. This provides the archiving functionality app so you can do the following:
 
-Archive your Rails models rather than delete them.
+##### In your models:
+
+```ruby
+user.archived?  #=> false
+user.archive!   #=> true
+user.archived?  #=> true
+user.unarchive! #=> true
+user.archived?  #=> false
+
+# With scopes available:
+User.archived 
+User.unarchived
+```
+
+##### In your views:
+
+_This would typically be added to a view helper._
+
+```html+erb
+<% if user.archived? %>
+  <%= link_to :Archive, archive_user_path(user) %>
+<% else %>
+  <%= link_to :Unarchive, archive_user_path(user) %>
+<% end %>
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'archivable'
+```ruby
+gem 'archivable'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install archivable
+```
+$ gem install archivable
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Database Migration
+
+First, you need to add the `archived` column to your model (which we we call `User` for this example):
+
+```
+$ rails g migration add_archived_to_users archived:boolean
+$ rake db:migrate
+```
+
+### Application Routes
+
+In your routes file (`config/routes.rb`):
+
+```ruby
+My::Application.routes.draw do
+  resources :users do
+    get archive,  on: :member
+    get archived, on: :collection
+  end
+end
+```
+
+### The Model
+
+Next, you need to include the model concern to gain access to some handy methods.
+
+```ruby
+class User < ActiveRecord::Base
+  include Archivable::Model
+
+  # ...
+end
+```
+
+### The Controller
+
+Lastly, you need to include the controller concern to handle the controller actions.
+
+```ruby
+class UsersController < ApplicationController
+  include Archivable::Controller
+
+  def index
+    @users = User.where(archived: false)
+  end
+
+  # ...
+end
+```
+
+### That's it.
+
+Now, instead of a delete link, you can do the following:
+
+```html+erb
+<%= link_to user.archived? ? :Unarchive : :Archive, archive_user_path(user) %>
+<%= link_to 'See Archived Users', archived_users_path %>
+```
 
 ## Contributing
 

data/lib/archivable/version.rb

@@ -1,3 +1,3 @@
 module Archivable
-  VERSION = '0.0.3'
+  VERSION = '1.0.0'
 end

data/spec/archivable_controller_spec.rb

@@ -12,7 +12,7 @@ describe Archivable::Controller do
 
     it 'should set the instance variable' do
       subject.archive
-      subject.get_model_instance_variable.should eq(subject.fake)
+      expect.get_model_instance_variable).to eq(subject.fake)
     end
 
     context 'when successfully archived' do

data/spec/spec_helper.rb

@@ -6,10 +6,6 @@ require 'action_controller'
 
 require 'archivable'
 
-RSpec.configure do |config|
-  config.color_enabled = true
-end
-
 class Fake
   attr_accessor :archived
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archivable
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - John Otander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Archive your Rails models rather than delete them.
@@ -144,4 +144,3 @@ test_files:
 - spec/archivable_controller_spec.rb
 - spec/archivable_model_spec.rb
 - spec/spec_helper.rb
-has_rdoc: