bali 1.0.0rc2 → 1.0.0rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c00de772752e74795255bcb26a90b5c9dee8e829
-  data.tar.gz: d22ec8ebd7fb7be2f179dd3c9bec50a700f00990
+  metadata.gz: 724bb6eef32c67456ef17908c706056bbe650894
+  data.tar.gz: 7db4ffe4112029cf64d89b693f3bb365e720122c
 SHA512:
-  metadata.gz: bc1e0ccba9e178f59f0a792c52a91315c81e755c83508f9a528b2c4a20127b5f586441e2273cef1c97e2ea59ca4952ea60fac6101d2b1493dde772acc937d237
-  data.tar.gz: da2384e2836663c6a7e99d7531fc040ea605c5659e5d8fe6f63bbd968bb0679d4ac45f8319aef214efab099c3cd4709ff3ffc19210176c7d34e6496a3313a3de
+  metadata.gz: 994dcb6cb86ceba1e4086ba713bf10fe62fb7987e5ba82e63a05f90600c22a4d70ce742a7c52cb39715d6864cad833f565ad079c509a014097c2c8fb2e82fe95
+  data.tar.gz: f3aa272ed470a2ee72d476643f728b5bc8a5e06957ddb306b487ab572710468f5a53f82f70f5ec8c522fad5b5757cd4fe5f14a5dd02ec83cb723e288c4e43dc8

data/README.md

@@ -58,40 +58,56 @@ Say:
 
 ```ruby
 class My::Transaction
+  include Bali::Objector
+
   attr_accessor :is_settled
   attr_accessor :payment_channel
 
   alias :is_settled? :is_settled
 end
+
+class My::Employee
+  include Bali::Objector
+
+  # working experience in the company
+  attr_accessor :exp_years
+end
 ```
 
 Assuming that there exist a variable `transaction` which is an instance of `My::Transaction`, we can query about whether the subtarget is granted to perform certain operation:
 
 ```ruby
-transaction.cant?(:general_user, :delete)    # => true
-transaction.can("general user", :update)     # => true
-transaction.can?(:finance_user, :delete)     # depend on context
-transaction.can?(:monitoring_user, :view)    # => true
-transaction.can?("monitoring user", :view)   # => true
-transaction.can?(:admin_user, :cancel)       # depend on context
-transaction.can?(:supreme_user, :cancel)     # => true
-transaction.can?(:guest, :view)              # => false
+transaction.cant?(:general_user, :delete)      # => true
+transaction.can("general user", :update)       # => true
+transaction.can?(:finance_user, :delete)       # depend on context
+transaction.can?(:monitoring_user, :view)      # => true
+transaction.can?("monitoring user", :view)     # => true
+transaction.can?(:admin_user, :cancel)         # depend on context
+transaction.can?(:supreme_user, :cancel)       # => true
+transaction.can?(:guest, :view)                # => false
+transaction.can?(:undefined_subtarget, :see)   # => false
+transaction.cant?(:undefined_subtarget, :new)  # => true
 ```
 
 If a rule is depending on a certain context, then the context will be evaluated to determine whether the subtarget is authorized or not.
 
 In the above example, deletion of `transaction` is only allowed if the subtarget is a "finance user" and, the `transaction` itself is already settled.
 
-Rule can also be called on a class, instead of on an object:
+Also, asking `can?` on which the subtarget is not yet defined will always return `false`. In the example above, as `undefined_subtarget` is by itself has never been defined in `describe` under `My::Transaction` rule class, `can?` for `undefined_subtarget` will always return `false`. But, `cant` on simillar ocassion will return `true`.
+
+Rule can also be tested on a class:
 
 ```ruby
 My::Transaction.can?(:supreme_user, :new)      # => true
 My::Transaction.can?(:guest, :view)            # => false
+My::Employee.can?(:undefined_subtarget, :new)  # => false, rule class for this is by its own undefined
 ```
 
+As we have never define the `rules_for` My::Employee before, any attempt to `can?` for `My::Employee` will return `false`, so does any attempt to object `cant?` on which will only return `true` for any given subtarget and operation.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bali. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/saveav/bali. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License
@@ -110,4 +126,12 @@ The gem is available as open source under the terms of the [MIT License](http://
 #### Version 1.0.0rc2
 1. [Fix bug when class's name, as a constant, is reloaded](http://stackoverflow.com/questions/2509350/rails-class-object-id-changes-after-i-make-a-request) (re-allocated to different address in the memory)
 2. Allow describing rule for `nil`, useful if user is not authenticated thus role is probably `nil`
-3. Remove pry from development dependency
+3. Remove pry from development dependency
+
+#### Version 1.0.0rc3
+1. Each target class should includes `Bali::Objector`, for the following reasons:
+   - Makes it clear that class do want to include the Bali::Objector
+   - Transparant, and thus less confusing as to where "can?" and "cant" come from
+   - When ruby re-parse the class's codes for any reasons, parser will be for sure include Bali::Objector
+2. Return `true` to any `can?` for undefined target/subtarget alike
+3. Return `false` to any `cant?` for undefined target/subtarget alike

data/lib/bali.rb

@@ -28,22 +28,23 @@ module Bali
   def rule_class_for(target)
     if target.is_a?(Symbol)
       class_name = ALIASED_RULE_CLASS_MAP[target]
-      raise Bali::DslError, "Rule class is not defined for: #{target}" if class_name.nil?
-
-      rule_class_for(class_name)
+      return class_name.nil? ? nil : rule_class_for(class_name)
     else
       raise Bali::DslError, "Target must be a class" unless target.is_a?(Class)
       rule_class = RULE_CLASS_MAP[target.to_s]
-      raise Bali::DslError, "Rule class is not defined for: #{target}" if rule_class.nil?
-      rule_class
+      return rule_class.nil? ? nil : rule_class
     end
   end
 
+  # attempt to search the rule group, but if not exist, will return nil
   def rule_group_for(target_class, subtarget)
     rule_class = Bali.rule_class_for(target_class)
-    rule_group = rule_class.rules_for(subtarget)
-    
-    rule_group
+    if rule_class
+      rule_group = rule_class.rules_for(subtarget)
+      return rule_group
+    else
+      return nil
+    end
   end
 
   def add_rule_class(rule_class)
@@ -94,8 +95,6 @@ module Bali
 
         # done processing the block, now add the rule class
         Bali.add_rule_class(self.current_rule_class)
-
-        target_class.include(Bali::Objector) unless target_class.include?(Bali::Objector)
       end
     end
   end

data/lib/bali/objector.rb

@@ -24,6 +24,11 @@ module Bali::Objector::Statics
       rule_group = Bali.rule_group_for(self.class, subtarget)
     end
 
+    # default of can? is false whenever RuleClass for that class is undefined
+    # or RuleGroup for that subtarget is not defined
+    return false if rule_group.nil?
+
+    # get the specific rule
     rule = rule_group.get_rule(:can, operation)
 
     # godly subtarget is allowed to do as he wishes
@@ -57,6 +62,10 @@ module Bali::Objector::Statics
       rule_group = Bali.rule_group_for(self.class, subtarget)
     end
 
+    # default of cant? is true whenever RuleClass for that class is undefined
+    # or RuleGroup for that subtarget is not defined
+    return true if rule_group.nil?
+
     rule = rule_group.get_rule(:cant, operation)
 
     # godly subtarget is not to be prohibited in his endeavours

data/lib/bali/version.rb

@@ -1,3 +1,3 @@
 module Bali
-  VERSION = "1.0.0rc2"
+  VERSION = "1.0.0rc3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bali
 version: !ruby/object:Gem::Version
-  version: 1.0.0rc2
+  version: 1.0.0rc3
 platform: ruby
 authors:
 - Adam Pahlevi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-15 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler