CanCanCanSee 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b8f8d1d948b2f9e478567e0dd3d5232b780bad1
-  data.tar.gz: facb4a6ec257267d28861a77215b8a9309510e06
+  metadata.gz: ff25ff4f47b4bb97aecfdad5e7630b42a6e5c14e
+  data.tar.gz: 6a48bcad44cdc045c96836aa7dad388f84b77c1a
 SHA512:
-  metadata.gz: 72e91981291c0983e05c0583d758646490401194a4e6bebbafedac0dd3b159ea282636828f4917213a08250a08052d7fb74dc4c1b93ef461fa88251fdab6fc5e
-  data.tar.gz: 95d69df88461a1aadf7a68c37331a6c7534d200e8a574bc53b12792530ff19a1bf89d2b96de5fa335cb0685ca4cb15ab392d64297a7c0bf6236fa06829006dc7
+  metadata.gz: 0465dfd4c70ebbaeb003a805d2b12cff35990121e23f1a48cce8755ab9b32fe35b295be21debb204b4f1ab179eab9d927302dd41ef9285e6e63760d72aaefb24
+  data.tar.gz: f6cc19753227e2357ec73ae449d784cc7a263872bf51499da5e1fc8438e353db2b8e01f1dfcdd80aee4b3e737513fa592608e1c097e3449bbea1ee83f7a4a82f

data/README.md

@@ -1,6 +1,6 @@
 # CanCanCanSee
 
-#THIS GEM IS IN DEVELOPMENT AND NOT RUNNING YET
+Read-only access to roles and abilities with CanCancan. Note: Since this relies on regex-magic at the moment, it requires a particular formatting that will be further articulated upon in future docs.
 
 ## Installation
 
@@ -20,13 +20,40 @@ Or install it yourself as:
 
 ## Usage
 
-N/A
+Your `Ability.rb` file should use a `case/when` statement for different roles and abilities for this to work.
+
+Create a `config/initializers/cancancansee.rb` file, and if you have a normal Ability.rb file include:
+
+`abilities_type = single`
+
+And if you have a custom multiple Ability.rb setup include:
+
+`abilities_type = multiple`
+
+Then, anywhere in your code or CLI, you have access to this command:
+
+```ruby
+CanCanCanSee.all_abilities
+
+#=> {"RoleOne"=>{"can"=>["manage Object"], "cannot"=>["delete Note", "edit Thing"},
+#=> "RoleTwo"=>{"can"=>["edit User"], "cannot"=>["manage Telephone"]}}
+
+#and if you only want to see abilities for a particular slug under multiple....
+CanCanCanSee.all_abilities[my_slug]
+
+#=> {"my_slug"=>{"RoleOne"=>{"can"=>["manage Object"], "cannot"=>["delete Note", "edit Thing"},
+#=> "RoleTwo"=>{"can"=>["edit User"], "cannot"=>["manage Telephone"]}},
+#=> "my_other_slug"=>{"RoleOne"=>{"can"=>["manage Object"], "cannot"=>["delete Note", "edit Thing"},
+#=> "RoleTwo"=>{"can"=>["edit User"], "cannot"=>["manage Telephone"]}}
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## TODO Before 1.0
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* Confirm support for single and multiple Ability.rb files
+* Create docs to show style guidelines to have gem work
+* Create post to show layout for slug-based auth
 
 ## Contributing
 

data/lib/CanCanCanSee.rb

@@ -1,4 +1,5 @@
 require "CanCanCanSee/version"
+require 'pry'
 
 module CanCanCanSee
 
@@ -6,22 +7,15 @@ module CanCanCanSee
 
   def self.initiate_gem
 
-    user_answer = "none"
-
-    while user_answer.downcase != "single" && user_answer.downcase != "multiple"
-      # puts "Single or multiple ability file?"
-      user_answer = "multiple"
-    end
-
-    type = user_answer
+    configuration_file = File.read('config/initializers/cancancansee.rb')
 
 
-    if type == "single"
+    if configuration_file.include?("abilities_type = single")
 
       my_file = File.read('app/models/ability.rb') # for single
       read_file(my_file)
 
-    elsif type == "multiple"
+    elsif configuration_file.include?("abilities_type = multiple")
 
       my_arr = []
 
@@ -63,7 +57,7 @@ module CanCanCanSee
       counter = 0
       roles = @current_file.scan(/when(.*)($|[ do])/)
       roles.map! { |item| item.to_s.gsub(/[^0-9a-z ]/i, '') }
-      roles.map! { |item| item[1..-1]}
+      roles.map! { |item| item[1..-2]}
 
       role_count = roles.length
       chunk_start = /when/ =~ @current_file
@@ -94,7 +88,7 @@ module CanCanCanSee
         array_of_can = []
 
         #establish can
-        can_abilities = all_text[roles[new_counter]].scan(/can (.*)($|[ do])/)
+        can_abilities = all_text[roles[new_counter]].scan(/can (.*)\n/)
 
         can_abilities.each do |can_ability|
           can_ability = can_ability[0]
@@ -105,7 +99,7 @@ module CanCanCanSee
         array_of_cannot = []
 
         #establish cannot
-        cannot_abilities = all_text[roles[new_counter]].scan(/cannot(.*)($|[ do])/)
+        cannot_abilities = all_text[roles[new_counter]].scan(/cannot(.*)\n/)
 
         cannot_abilities.each do |cannot_ability|
           cannot_ability = cannot_ability[0]
@@ -133,6 +127,9 @@ module CanCanCanSee
 
         can_abilities.each do |can_ability|
           can_ability = can_ability[0]
+          if can_ability.include?("do")
+            can_ability =  "#{/(.*) do/.match(can_ability)[1]} WITH BLOCK"
+          end
           array_of_can << can_ability.gsub(/[^0-9a-z ]/i, '')
         end
 
@@ -144,6 +141,9 @@ module CanCanCanSee
 
         cannot_abilities.each do |cannot_ability|
           cannot_ability = cannot_ability[0]
+          if cannot_ability.include?("do")
+            cannot_ability =  "#{/(.*) do/.match(cannot_ability)[1]} WITH BLOCK"
+          end
           array_of_cannot << cannot_ability.gsub(/[^0-9a-z ]/i, '')
         end
 
@@ -158,9 +158,9 @@ module CanCanCanSee
 
   #public methods
 
-  def self.all_roles
+  def self.all_roles(desired_slug=nil)
     initiate_gem
-    return MY_GLOBAL_HOLDER_OF_ABILITY.keys
+    return MY_GLOBAL_HOLDER_OF_ABILITY[desired_slug].keys
 
   end
 

data/lib/CanCanCanSee/version.rb

@@ -1,3 +1,3 @@
 module CanCanCanSee
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: CanCanCanSee
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nick Schwaderer