active_conformity 0.2.13 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04c7e1d71487e2d58faf2cbf582e10386f4b1018
-  data.tar.gz: 5f5a5e28dae4bb907dcf8644bb9de7c3157c15b4
+  metadata.gz: b887d6011a6343f3f3e1fc483a3f8d412e9d2dee
+  data.tar.gz: 405673f04c38f9befc12cb4e1465544ab2a72c27
 SHA512:
-  metadata.gz: 5fd79e607d2317bc41ad6c9f2b46653e6ff54cf345742db1e3a9d9934d0552848230fd205998928d02bed98fddb86383ae16ee2e68f76a671f04442525ae1095
-  data.tar.gz: e50e71111dc5c00dc907e09af1688574367ce5f433eb61323a007a283844f215014bc8291af887b3af9804c61c4fa1bb47a53c7325d0a5cb3a21a375175701c2
+  metadata.gz: 1cde6a00f8981dcf2d88804dbfc1b72dec9c51bcb7e73e7f1a137d18e9a3a4b32a564cb326663aa26e2129eba55bd11dab8a0d74c6934ad36223b41069f7ef2e
+  data.tar.gz: 777988858ef4c4f2ec9c538d6e90f08bedaa23825faa882d8b88a75e0ec30375c7d411344936e7efd18cf998730518b0630c12846461e05eb33777b9ac4e4c83

data/README.md

@@ -1,4 +1,6 @@
 # ActiveConformity
+
+[![Join the chat at https://gitter.im/dandlezzz/active_conformity](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dandlezzz/active_conformity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Code Climate](https://codeclimate.com/github/dandlezzz/active_conformity/badges/gpa.svg)](https://codeclimate.com/github/dandlezzz/active_conformity)
 
 Your favorite rails validations driven not by code but by your data.
@@ -31,23 +33,23 @@ ActiveConformity comes with a helpful install generator.
  ActiveConformity is for use when validating if objects are of a specific composition.
  For example, lets say you have the following model structure:
 
- ```
+ ```ruby
  class Car
- 	has_one :engine
+ 	belongs_to :engine
  	#attrs :size
  end
 
  class Engine
- 	belongs_to :car
+
  end
  ```
 
-In this example you have a database full of different engines. Each car model has a link to these things. If you want ensure that the diesel engine is on a car of a size 2000 you have a couple of options.
+In this example you have a database full of different engines. Each car instance has an engine. If you want ensure that the diesel engine is on a car of a size 2000 you have a couple of options.
 
-```
+```ruby
 class Car
-	has_one :engine
-    validate :proper_engine
+  belongs_to :engine
+  validate :proper_engine
 
     def proper_engine
     	return true if size >= 2000 && engine.name == "diesel"
@@ -57,14 +59,14 @@ end
 
 ```
 
-This works but can become very complex if you have lots of engines and even more complicated conditions. ActiveConformity provides a way to add these conditions to your database, as json.
+This works but can become very complex if you have lots of engines and each with their own special requirements of the car. ActiveConformity provides a way to add these conditions to your database, as json, and then run the validations from the persisted json, that json is referred to as a conformity_set.
 
-```
+```ruby
 diesel_engine = Engine.find_by(name: "diesel")
 diesel_engine.add_conformity_set!( {size: {:numericality => { :greater_than => 2000} } }, conformist_type: "Car")
 
-car1 = Car.create!(size: 2000, engine: diesel_engine)
-car1.conforms? # true
+car = Car.create!(size: 2000, engine: diesel_engine)
+car.conforms? # true
 car2 = Car.create!(size: 1000, engine: diesel_engine)
 car2.conforms? # false
 car2.conformity_errors # [{size: "car is too small for diesel engine"}]
@@ -83,9 +85,10 @@ ActiveConformity refers to the objects that tell other objects what do as confor
 
 There are several methods available to inspect what makes an object on conform. In the previous example if you want to see all of the rules the car most conform to you can do the following.
 
+```ruby
+car.aggregate_conformity_set # {:size=> {:numericality => { :greater_than => 2000} } }
 ```
-car1.aggregate_conformity_set # {size: {:numericality => { :greater_than => 2000} } }
-```
+
 
 This shows all of the validations that the model will have to run through when .conforms? is called.
 
@@ -93,19 +96,35 @@ This shows all of the validations that the model will have to run through when .
 
 In order to debug conformity errors, ActiveConformity provides several methods to query the database in order to get a better understanding of why the object conforms or does not.
 
-```
-car1.conformable_references #returns [diesel_engine]
+```ruby
+car.conformable_references #returns [diesel_engine]
 ```
 The conformable references returns a list of all the objects that the car gets a conformity set from. Additionally, for even more fine grained debugging you can call
-```
-car1.conformity_sets_by_reference # {"Engine id: 1" =>{size: {:numericality => { :greater_than => 2000} } } }
+
+```ruby
+car.conformity_sets_by_reference # {"Engine id: 1" =>{:size=> {:numericality => { :greater_than => 2000} } } }
 ```
 This returns a complex hash that shows the id of all of the objects mapped to their individual conformity_set.
 
-##
+## Removing Conformity sets
+
+ActiveConformity provides two ways to remove a misplaced conformity rule or set from a conformable. For example, if you had incorrectly added an extra conformity set to the diesel engine, you could remove it like so:
+
+```ruby
+# the bad rule
+diesel_engine.add_conformity_set!( {size: {:numericality => { :greater_than => 999999} } }, conformist_type: "Car")
+# remove it this way
+diesel_engine.remove_coformity_rule!(:size)
 
+```
+The bang here will run a save!, without the bang the diesel engine will still need to save in order to persist. Additionally, if you want to remove all of the conformity sets for a conformable, you can do the following:
 
+```ruby
+diesel_engine.remove_rules!
+```
+Again this method can be used with or without a bang!
 
+##
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -119,3 +138,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+
+## Help and Inspiration
+Thanks to [Dan Barrett](https://github.com/thoughtpunch) who has provided guidance and inspiration for this project.

data/active_conformity.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "activerecord", "~> 4.2"
   spec.add_development_dependency "sqlite3"
 end

data/lib/active_conformity/conformable.rb

@@ -26,6 +26,15 @@ module ActiveConformity
       self.conformity_set = conformity_set.to_json
     end
 
+    def remove_rules
+      self.conformity_set = {}.to_json
+    end
+
+    def remove_rules!
+      remove_rules
+      save!
+    end
+
     def remove_coformity_rule!(attr)
       remove_coformity_rule(attr)
       save!

data/lib/active_conformity/conformable_extensions.rb

@@ -11,8 +11,9 @@ module ActiveConformity
       end
 
       def conforming_dependents(*dependents)
+        association_names = self.reflect_on_all_associations.map(&:name)
         dependents.each do |d|
-          if !self.reflect_on_all_associations.map(&:name).include?(d)
+          if !association_names.include?(d)
             raise "NOT A VALID DEPENDENT, MUST BE ONE OF THE MODEL'S ASSOCIATIONS!"
           end
         end

data/lib/active_conformity/conformity_set_validator.rb

@@ -56,8 +56,6 @@ class ConformitySetValidator < ActiveModel::EachValidator
     true
   end
 
-  #conformity set by conformable
-
   def is_a_conformists_attribute?(str)
     str = str.to_s
     if !conformists_attributes.include?(str)

data/lib/active_conformity/version.rb

@@ -1,3 +1,3 @@
 module ActiveConformity
-  VERSION = "0.2.13"
+  VERSION = "0.2.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_conformity
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.14
 platform: ruby
 authors:
 - dandlezzz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +97,6 @@ files:
 - active_conformity.gemspec
 - bin/console
 - bin/setup
-- lib/.DS_Store
 - lib/active_conformity.rb
 - lib/active_conformity/conformable.rb
 - lib/active_conformity/conformable_extensions.rb
@@ -129,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Database driven validations.