poly_belongs_to 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a09a566220f86ecc139ff228f2590894d918641
-  data.tar.gz: 3f13cd3e0a7752904f006c2980b3a49504e748e5
+  metadata.gz: 429c2eee4201eee8c86e3272ead316fd2c5babfe
+  data.tar.gz: a471110519e11c8ac2f0ea33f058a71231353379
 SHA512:
-  metadata.gz: ba67944727ff03ce9d2e90e3c1893f197dc1ef176782c7ca19ab6274e44696adfc42e0a4060b725a4f32c5cbc6701c44ad9b18f4a0fc4de40e7f172f7937b84e
-  data.tar.gz: ee255ce20742673808e02ceed2e287794b38631cf7b0837f069b08c0f58afc7fa43065cc96c1e64bbd0122f277200ec716428e8e043575be831ccb82f3c456d0
+  metadata.gz: 8fd4f92b85e7092c5a5287a47206bc0a1deeb4368453e135acab5f9280983ecae04c80911f1d6b94217c94488241a9fe5deb85297967a4bbf80c7a229dbf7328
+  data.tar.gz: 2289fb23dd61bc46beef6b989a3408d402169eaf8887a5bac80d04206a401f0951ec2233eaa1dc367ced7b1c1ba5149508784e9f6c21692fe50aec2212f5fa84

data/README.md

@@ -1,55 +1,89 @@
-#Poly Belongs To
+#PolyBelongsTo
+[![Gem Version](https://badge.fury.io/rb/poly_belongs_to.svg)](http://badge.fury.io/rb/poly_belongs_to)
 [![Code Climate](https://codeclimate.com/github/danielpclark/PolyBelongsTo/badges/gpa.svg)](https://codeclimate.com/github/danielpclark/PolyBelongsTo)
 
 Is an ActiveRecord library which will let you check your DB Objects polymorphism in a more across-the-board
 meta-programatically friendly way.
 
+#Installation
+
+### Gem
+
+Just include it in your Gemfile and then run bundle:
+```ruby
+gem 'poly_belongs_to'
+```
+
+###Merge via git
+Be in your Rails project directory.  Make sure you git is up to date with all your latest changes.  Then:
+
+```shell
+git fetch git@github.com:danielpclark/PolyBelongsTo.git install:pbt
+git merge pbt
+```
+
+And then enter a description for this merge into your project.  Save the message, exit, and you're done!
+
+##Example Usage
+
 ```ruby
 # Is Polymorphic?
 MyObject.new.poly?
 # => true
-MyOject.poly?
+MyOject.poly?                   # Recommended usage on class name
 # => true
+User.first.poly?
+# => false
+User.poly?                      # Recommended usage on class name
+# => false
     
 # Polymorphic Belongs To Relation Table
 MyObject.new.pbt
 # => :my_objectable
-MyObject.pbt
+MyObject.pbt                    # Recommended usage on class name 
 # => :my_objectable
-    
+User.first.pbt
+# => nil
+User.pbt                        # Recommended usage on class name
+# => nil 
+
+# Params name
+MyObject.new.pbt_params_name
+# => :my_objectable_attributes
+MyObject.pbt_params_name        # Recommended usage on class name
+# => :my_objectable_attributes
+User.first.pbt_params_name
+# => :user
+User.pbt_params_name            # Recommended usage on class name
+# => :user
+
+# Polymorphic DB field names
+MyObject.new.pbt_id_sym
+# => :my_objectable_id
+MyObject.pbt_id_sym             # Recommended usage on class name
+# => :my_objectable_id
+MyObject.new.pbt_type_sym
+# => :my_objectable_type
+MyObject.pbt_type_sym           # Recommended usage on class name
+# => :my_objectable_type
+# The above methods return nil for non polymorphic Objects
+
 # Polymorphic Belongs To Relations ID
-MyObject.first.pbt_id
+MyObject.first.pbt_id           # Retrieve instance value
 # => 123
+# The above method returns nil for non polymorphic Objects
     
 # Polymorphic Belongs To Relations Type
-MyObject.first.pbt_type
+MyObject.first.pbt_type         # Retrieve instance value
 "User"
+# The above method returns nil for non polymorphic Objects
 ```    
 
 And that's that!
 
-#Installation
-
-### Gem
-Install the gem via your command line:
-```shell
-gem install poly_belongs_to
-```
-
-Or just include it in your Gemfile and then run bundle:
-```ruby
-gem 'poly_belongs_to'
-```
-
-###Merge via git
-Be in your Rails project directory.  Make sure you git is up to date with all your latest changes.  Then:
-
-```shell
-git fetch git@github.com:danielpclark/PolyBelongsTo.git install:pbt
-git merge pbt
-```
+##TODO
 
-And then enter a description for this merge into your project.  Save the message, exit, and you're done!
+Basic specs
 
 #License
 

data/lib/poly_belongs_to/version.rb

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

data/lib/poly_belongs_to.rb

@@ -16,6 +16,24 @@ module PolyBelongsTo
     def self.poly?
       !!reflect_on_all_associations(:belongs_to).first.try {|i| i.options[:polymorphic] }
     end
+
+    def self.pbt_params_name
+      if poly?
+        "#{table_name}_attributes".to_sym
+      else
+        name.downcase.to_sym
+      end
+    end
+
+    def self.pbt_id_sym
+      val = pbt
+      val ? "#{pbt}_id".to_sym : nil
+    end
+
+    def self.pbt_type_sym
+      val = pbt
+      val ? "#{pbt}_type".to_sym : nil
+    end
   end
   
   def pbt
@@ -36,6 +54,17 @@ module PolyBelongsTo
     val ? eval("self.#{val}_type") : nil
   end
 
+  def pbt_id_sym
+    self.class.pbt_id_sym
+  end
+
+  def pbt_type_sym
+    self.class.pbt_type_sym
+  end
+
+  def pbt_params_name
+    self.class.pbt_params_name
+  end
 end
 
 ActiveRecord::Base.send(:include, PolyBelongsTo)

data/test/dummy/log/test.log

@@ -0,0 +1,5 @@
+   (0.1ms)  begin transaction
+-----------------------------
+PolyBelongsToTest: test_truth
+-----------------------------
+   (0.0ms)  rollback transaction

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poly_belongs_to
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -88,6 +88,8 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
+- test/dummy/db/test.sqlite3
+- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -121,6 +123,7 @@ summary: Shorthand polymorphic testing and universal identifiers.
 test_files:
 - test/poly_belongs_to_test.rb
 - test/test_helper.rb
+- test/dummy/db/test.sqlite3
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/assets.rb
@@ -151,6 +154,7 @@ test_files:
 - test/dummy/public/500.html
 - test/dummy/Rakefile
 - test/dummy/config.ru
+- test/dummy/log/test.log
 - test/dummy/bin/rake
 - test/dummy/bin/rails
 - test/dummy/bin/bundle