descendants_describable 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 570e2a661194ac0301464cfe6fcdf0c23c99d344
-  data.tar.gz: 7df6c28fa47ca1bed47c159786dc3a3479a9b965
+  metadata.gz: 78b03898214e5b116c6901c22e91ea10f6fb2a04
+  data.tar.gz: 4357f9507a420055f5ccd3668221c4c88e2320bf
 SHA512:
-  metadata.gz: f670e49f3ff21073f732e4c53bdb8841c50082e7aba6915cabe1dcad5731d0bc345ba0d1c2dc702774845cea39a5cd16ed341caa8f6c85ff9d08c8095f7d1159
-  data.tar.gz: 5d49b9bfc1006b6c5fa8bf7f4cf14d7f20f4d7859f9b667f532203706bac2c7edaf92ddd7bfc53b4ba829a9a88daa6c86f1df21f12a88e9084a47f2e062542e6
+  metadata.gz: 80694bea36aaf587c583ea138878d96d3b174a2d7e22f991dbcd039a311db3dca776c6f1c4de8389bab9ab41b33c2533d6dda257971fb587dc920bc9fb7af567
+  data.tar.gz: 0ba02c0d5167fda0d53d723273415e67a4d2da33300fdd3401e339d2ef44ef60ea474f8e4cc1e4a21d0bfb47c600e32be0d4b7680d222d3d20a6ad7b4bc6e282

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-2.0.0@descendants_describable --create
+rvm ruby-2.1.1@descendants_describable --create

data/README.md

@@ -1,6 +1,29 @@
-# DescendantsDescribable
+# descendants_describable.gem
 
-TODO: Write a gem description
+This gem provides a shorthand DSL for including re-usable sets of mixin modules across a large set of STI models.
+If you find yourself with a folder of subclasses full of boilerplate and shared functionality, this gem will let you replace
+those files with one or a few small files that read more descriptively, like so:
+
+``` ruby
+
+MySuperClass.describe_descendants_with(MySuperClassMixins) do
+  type :some_type
+  type :another_subtype do
+    email_addressable
+  end
+
+  type :some_domain_event do
+    email_addressable
+    payment_validatable
+  end
+end
+```
+
+## Why?
+
+My [blog post](http://winfred.nadeau.io/2014/03/22/taming-the-activities-table/) describes the evolution of this gem at [Hired](http://hired.com) pretty well.
+
+TL;DR imagine the example in the [usage section](#usage) with a marketplace's domain described therein.
 
 ## Installation
 
@@ -18,7 +41,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Here's the real-world example that gave life to this gem:
+
+```ruby
+
+  # config/initializers/activities.rb
+
+  Activity.describe_descendants_with(Activity::Descriptors) do
+    type :completed_survey do
+      user_required
+    end
+
+    type :bid_on_developer do
+      approved_employers_only
+      target_required
+    end
+
+    type :auction_membership_confirmed do
+      approved_developers_only
+      actor_unique_to_auction
+      target_required
+    end
+    # ... others omitted for brevity ...
+end
+
+```
+
+Given this example, one is describing the descendants of an Activity class (that also live on the activities table with a type column for STI), the following is happening.
+
+
+1. Each "type" declaration instantiates a new subclass by that name camelized.
+2. Each method called inside the block provided to a "type" declaration will include into that new subclass a module by that method name camelized in the provided *descriptor namespace*.
+
+So the above is basically shorthand for this:
+
+```ruby
+
+# in models/completed_survey.rb
+class CompletedSurvey < Activity
+  include Activity::Descriptors::UserRequired
+end
+
+# in models/bid_on_developer.rb
+class BidOnDeveloper < Activity
+  include Activity::Descriptors::ApprovedEmployersOnly
+  include Activity::Descriptors::TargetRequired
+end
+
+# in models/auction_membership_confirmed.rb
+class AuctionMembershipConfirmed < Activity
+  include Activity::Descriptors::ApprovedEmployersOnly
+  include Activity::Descriptors::ActorUniqueToAuction
+  include Activity::Descriptors::TargetRequired
+end
+
+```
+
 
 ## Contributing
 

data/descendants_describable.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activerecord', '~> 3.2.13'
-  spec.add_dependency 'activesupport', '~> 3.2.13'
+  spec.add_dependency 'activerecord', '~> 4.1'
+  spec.add_dependency 'activesupport', '~> 4.1'
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/lib/descendants_describable/version.rb

@@ -1,3 +1,3 @@
 module DescendantsDescribable
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: descendants_describable
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - winfred
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-11 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: 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: pry
   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'
 description: Turn a module of behavioral concerns into a DSL for describing a large
@@ -116,8 +116,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".gitignore"
+- ".rvmrc"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -138,17 +138,17 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Turn a module of behavioral concerns into a DSL for describing a large set