bannable 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3046cbc7ae391a11b60147d3f6c65d317622a08b
-  data.tar.gz: af0338738f31a939614d4e0ad24c811de3f9b26e
+  metadata.gz: 9f3a1a4db883a3d8e841f6d34ee09256a84bf931
+  data.tar.gz: c10aadac3cac88c148f171032da8673b1ca1e300
 SHA512:
-  metadata.gz: 570b9d1a43e2f7e9a82789513fb46ba68de7f833467e262a99bfbf0119c7757a18b3050b924a847fef5bba12dfd29f19dc594fc1393c71a44649e73d704995c8
-  data.tar.gz: ce92e1772ca2788ed5cd8c0b4cfceb97c5e7465bc8293f6e1832364d95e48f7616b02b460f1cefea7114752748b82bbaa3e06713060358af8a8f50ab881842b1
+  metadata.gz: ec8e99692dea63ea321b1ba35892fbdbecfbff33f274c78878151a91d1b284fcf12c192fa36e9fefb745067be5abfe1ba9c422e2b6d1f495a1e8bcef30942736
+  data.tar.gz: 092d9978fb7eab47a2723d34bfa61dfefd696d637a9509b24e9d4bf3dbcf73f41ec51937d23cb8fdf81f4868bf242f454b40a1e06b193f048d5f390a3c749536

data/README.md

@@ -1,5 +1,7 @@
 # Bannable
-Allow models to be bannable in Rails.
+Allow models to be bannable in Rails. Designed to work like the [hideable](https://github.com/joecorcoran/hideable) gem.
+
+[![Build Status](https://travis-ci.org/notrab/bannable.svg)](https://travis-ci.org/notrab/bannable)
 
 ## Installation
 
@@ -17,7 +19,21 @@ Or install it yourself as:
 
 ## Usage
 
-Add `bannable` to models you wish to be bannable.
+Add the following to your models you wish to be bannable
+
+    extend Bannable::ActiveRecord
+    bannable
+
+Something like...
+
+```ruby
+class User
+  extend Bannable::ActiveRecord
+  bannable
+end
+```
+
+You'll then need to run `rails generate bannable:migration Model`. Replacing `Model` with an array of the `Bannable` models.
 
 ## Contributing
 

data/bannable.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jamie Barton"]
   spec.email         = ["jamie@codethisway.com"]
   spec.summary       = %q{Ban your ActiveRecord models}
-  spec.description   = %q{Easily set models as banned}
+  spec.description   = %q{Easily set ActiveRecord models as banned. Designed to work like the hideable gem.}
   spec.homepage      = "http://github.com/notrab/bannable"
   spec.license       = "MIT"
 

data/lib/bannable/active_record/instance_methods.rb

@@ -12,10 +12,6 @@ module Bannable
         self.banned = nil
         self.save!
       end
-
-      def banned?
-        self.banned?
-      end
     end
   end
 end

data/lib/bannable/active_record.rb

@@ -1,6 +1,6 @@
 module Bannable
   module ActiveRecord
-    def bannable(options = {})
+    def bannable
       send :include, InstanceMethods
     end
 

data/lib/bannable/version.rb

@@ -1,3 +1,3 @@
 module Bannable
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/bannable.rb

@@ -1,3 +1,3 @@
+require "bannable/version"
 require 'bannable/active_record'
 require 'bannable/active_record/instance_methods'
-require "bannable/version"

data/travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bannable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jamie Barton
@@ -38,7 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Easily set models as banned
+description: Easily set ActiveRecord models as banned. Designed to work like the hideable
+  gem.
 email:
 - jamie@codethisway.com
 executables: []
@@ -56,6 +57,7 @@ files:
 - lib/bannable/active_record/instance_methods.rb
 - lib/bannable/version.rb
 - lib/generators/bannable/migration_generator.rb
+- travis.yml
 homepage: http://github.com/notrab/bannable
 licenses:
 - MIT