grant-front 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 287c0d37f86c2db8a7fa5e4db99ad01913b6a8d8
-  data.tar.gz: 0f79b9211eda863ebc45b00aba19db9d8b5e8bf3
+  metadata.gz: 5e3f6aaccaca24c6a5e7dff34a3002008b1ee470
+  data.tar.gz: 44be6c4edf11da60d4f76185a5f45915d17d6b41
 SHA512:
-  metadata.gz: ea2c1e0274c28c372b82d4325245bf8b078683f7a770cfb2f8d90943c563c4f00fb677e9eb270443fdd6d026204b0503b9d5559782492d593b72667a66c1a7e6
-  data.tar.gz: ca5a3d0eb8fdc20d27bed631b3b06d3d3c7181342d8fe47227bacdc8c25e4b44a04c01c309bb0074103b43df79b446d2757b301e342bbcc0708e8c79f27e5a56
+  metadata.gz: 327888963d8caae5220afa74ddb45779956d283ae7f0ac179e5d086b2c17d8afbbe84d3582bfe4147dfc7675a0a9d2909ff8971a43fa14f5a687b0681136277a
+  data.tar.gz: 199be717bcf61ac252ea1e954a87dd3b205346c50b1c30cdbe5cd6eb3910791d56620978656269c6ff0322caba613b4a9ae98bade1c49e4c25150b222d044936

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/grant-front.svg)](http://badge.fury.io/rb/grant-front) [![Build Status](https://travis-ci.org/ogom/grant-front.png?branch=master)](https://travis-ci.org/ogom/grant-front)
 
-Authorization Grant Front on Rails.
+Policies grant of role for authorization on Rails.
 
 ## Installation
 
@@ -18,15 +18,46 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+## Usage
+
+### Rack
+
+Add this line to your `config/routes.rb`:
 
 ```
-$ gem install grant-front
+mount GrantFront::Engine, at: '/rails/info/policies'
 ```
 
-## Usage
+Draw by selecting the policy:
+
+![example](http://ogom.github.io/grant-front/assets/img/example.png)
+
+### Rake
+
+Draw by rake command:
+
+```
+$ rake grant_front:draw
+
+### User
+
+||foo|bar|baz|
+|:-|:-:|:-:|:-:|
+|create|o|o|o|
+|update|o|o||
+|destroy||o|o|
+```
+
+## Policy Example
+
+Install the [Pundit](https://github.com/elabs/pundit), and to the generate:
 
-### Policy Example
+```
+$ rails generate pundit:install
+$ rails generate pundit:policy user
+```
+
+Include **GrantFront** line to your `policies/application_policy.rb`:
 
 ```
 class ApplicationPolicy
@@ -40,6 +71,8 @@ class ApplicationPolicy
 end
 ```
 
+Add **grant** line to your `policies/user_policy.rb`:
+
 ```
 class UserPolicy < ApplicationPolicy
   def create?
@@ -56,26 +89,6 @@ class UserPolicy < ApplicationPolicy
 end
 ```
 
-### Rake
-
-```
-$ rake grant_front:draw
-```
-
-||foo|bar|baz|
-|:-:|:-:|:-:|:-:|
-|create|o|o|o|
-|update|o|o||
-|destroy||o|o|
-
-### Rack
-
-Add this line to your `config/routes.rb`:
-
-```
-mount GrantFront::Engine, at: '/rails/info/policies'
-```
-
 ## License
 
 * MIT

data/lib/grant-front/diagram.rb

@@ -11,21 +11,23 @@ module GrantFront
     end
 
     def create
-      policies = {}
-      GrantFront::Policy.all(@options).each do |klass|
-        policies[klass.to_s.to_sym]  = GrantFront::Policy.find(klass)
+      policies = []
+      GrantFront::Policy.all(@options).each do |policy|
+        if @options[:classes].nil? or @options[:classes].include?(policy.klass)
+          policies << GrantFront::Policy.find(policy.klass)
+        end
       end
 
       text = ''
-      policies.keys.each do |policy|
-        text += "\n### #{policy.to_s.gsub(/Policy$/, '')} \n\n"
-        if policies[policy][:roles].count > 0
-          text += "||#{policies[policy][:roles].join('|')}|\n"
-          text += "|:-|#{policies[policy][:roles].map{':-:'}.join('|')}|\n"
-          policies[policy][:methods].keys.each do |method|
+      policies.each do |policy|
+        text += "\n### #{policy.name}\n\n"
+        if policy.roles.count > 0
+          text += "||#{policy.roles.join('|')}|\n"
+          text += "|:-|#{policy.roles.map{':-:'}.join('|')}|\n"
+          policy.methods.keys.each do |method|
             raw = "|#{method}|"
-            policies[policy][:roles].each do |role|
-              raw += 'o' if policies[policy][:methods][method].include?(role)
+            policy.roles.each do |role|
+              raw += 'o' if policy.methods[method].include?(role)
               raw += '|'
             end
             text += "#{raw}\n"

data/lib/grant-front/engine.rb

@@ -9,8 +9,6 @@ module GrantFront
 
     def call(env)
       @request = Rack::Request.new(env)
-      text = Diagram.new(rake: false).create
-      policy_tag = Kramdown::Document.new(text).to_html
 
       status = 200
       headers = {'Content-Type' => 'text/html'}
@@ -20,12 +18,47 @@ module GrantFront
     end
 
     private
-    def application_template
-      root_path = Pathname.new(File.expand_path('..', File.dirname(__FILE__)))
-      templates_path = File.join(root_path, 'templates')
-      application_layout = File.expand_path('application.html.erb', File.join(templates_path, 'layouts'))
-      File.read(application_layout)
-    end
+      def policy_link_to
+        "<a href=#{request.script_name}>Policy</a>"
+      end
+
+      def policies_tag
+        raw = ""
+        policies = GrantFront::Policy.all(rake: false)
+
+        raw += "<div><ul>"
+        raw += policies.map do |policy|
+          raw = "<li"
+          if '/' + policy.urn == request.path_info
+            raw += " class='active'"
+          end
+          raw += "><a href=#{request.script_name}/#{policy.urn}>#{policy.name}</a>"
+          raw += "</li>"
+        end.join("\n")
+        raw += "</ul></div>"
+
+        raw
+      end
+
+      def policy_tag
+        policies = GrantFront::Policy.all(rake: false)
+        classes = policies.inject([]) do |arr, policy|
+          arr << policy.klass if '/' + policy.urn == request.path_info
+          arr
+        end
+        classes = nil if classes.count == 0
+
+        text = Diagram.new(rake: false, classes: classes).create
+        Kramdown::Document.new(text).to_html
+      end
+
+      def application_template
+        root_path = Pathname.new(File.expand_path('..', File.dirname(__FILE__)))
+        templates_path = File.join(root_path, 'templates')
+        application_layout = File.expand_path('application.html.erb', File.join(templates_path, 'layouts'))
+        File.read(application_layout)
+      end
+    # end private
 
     class << self
       def prototype

data/lib/grant-front/policy.rb

@@ -1,5 +1,7 @@
 module GrantFront
   class Policy
+    attr_accessor :klass, :name, :methods, :roles
+
     class << self
       def all(options={})
         options[:rake] = true if options[:rake].nil?
@@ -10,7 +12,7 @@ module GrantFront
             require item if options[:rake]
             name = File.basename(item, '.*')
             unless name == 'application_policy'
-              arr << Object.const_get(name.camelize)
+              arr << self.new(name.camelize)
             end
             arr
           end
@@ -21,7 +23,7 @@ module GrantFront
             unless name == :Config
               klass = Object.const_get(name)
               if klass.class == Class && klass.superclass == ApplicationPolicy
-                arr << klass
+                arr << self.new(klass)
               end
             end
             arr
@@ -31,29 +33,41 @@ module GrantFront
         constants
       end
 
-      def find(klass=nil)
-        raw = {methods: {}, roles: []}
+      def find(klass)
+        policy = self.new(klass.to_s)
+        klass = Object.const_get(klass.to_s)
         reg = Regexp.new(/\?$/)
         user = Struct.new(:id, :roles).new(1, [])
 
         klass.mock!
-        policy = klass.new(user, user)
-        policy.methods.each do |name|
+        klass_policy = klass.new(user, user)
+        klass_policy.methods.each do |name|
           if name =~ reg
-            owner = policy.method(name).owner
+            owner = klass_policy.method(name).owner
             if owner == klass or owner == ApplicationPolicy
-              roles = policy.send(name)
+              roles = klass_policy.send(name)
               roles ||= []
-              raw[:methods][name.to_s.gsub(reg, '').to_sym] = roles
-              raw[:roles] += roles
-              raw[:roles].uniq!
+              policy.methods[name.to_s.gsub(reg, '').to_sym] = roles
+              policy.roles += roles
             end
           end
         end
         klass.unmock!
 
-        raw
+        policy.roles.uniq!
+        policy
       end
     end
+
+    def initialize(klass)
+      @klass = klass.to_s
+      @name = @klass.gsub(/Policy$/, '')
+      @methods = {}
+      @roles = []
+    end
+
+    def urn
+      self.name.downcase
+    end
   end
 end

data/lib/grant-front/version.rb

@@ -1,3 +1,3 @@
 module GrantFront
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/templates/layouts/application.html.erb

@@ -17,11 +17,43 @@
     white-space: pre-wrap;
   }
 
+  a {
+    color: #000;
+    text-decoration: none;
+    padding-left: 4px;
+    padding-right: 10px;
+  }
+  a:visited { color: #000; }
+  a:hover { color: #000; background-color:#fff; }
+
   h2 { padding-left: 10px; }
 
+  li { padding: 0px 4px; }
+  li.active { background-color: #666;}
+  li.active > a { color: #fff;}
+  li.active > a:hover { color: #fff; background-color:#666; }
+
+  div.policies {
+    float:left;
+    padding-right: 20px;
+    padding-bottom: 400px;
+    border-right: solid #eee;
+  }
+
+  div.policies h3 {
+    padding-left: 16px;
+  }
+
   div.policy {
-    padding-top: 8px;
-    padding-left: 80px;
+    padding-left: 150px;
+  }
+
+  div.policy h3 {
+    padding-top: 12px;
+  }
+
+  div.policy table {
+    padding-left: 10px;
   }
 
   div.policy th,
@@ -41,7 +73,12 @@
 </head>
 <body>
   <h2>Policies</h2>
-  <p>Draws Authorization Grant Roles</p>
+  <p>Policies grant of role for authorization</p>
+
+  <div class='policies'>
+    <h3><%= policy_link_to %></h3>
+    <%= policies_tag %>
+  </div>
 
   <div class='policy'>
     <%= policy_tag %>

data/spec/lib/diagram_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe GrantFront::Diagram do
+  describe "#create" do
+    let(:diagram) { GrantFront::Diagram.new(classes: ['UserPolicy']) }
+
+    it "returns diagram" do
+      expect(diagram.create).to eq(
+        "\n### User\n" +
+        "\n" +
+        "||foo|bar|baz|\n" +
+        "|:-|:-:|:-:|:-:|\n" +
+        "|create|o|o|o|\n" +
+        "|update|o|o||\n" +
+        "|destroy||o|o|\n"
+      )
+    end
+  end
+end

data/spec/lib/policy_spec.rb

@@ -2,20 +2,30 @@ require 'spec_helper'
 
 describe GrantFront::Policy do
   describe ".all" do
-    it "returns a policy" do
-      expect(GrantFront::Policy.all.count).to eq(1)
+    let(:policy) { GrantFront::Policy.all.first}
+
+    it "returns klass of policy" do
+      expect(policy.klass).to eq('UserPolicy')
+    end
+
+    it "returns name of policy" do
+      expect(policy.name).to eq('User')
+    end
+
+    it "returns urn of policy" do
+      expect(policy.urn).to eq('user')
     end
   end
 
   describe ".find" do
-    let(:policy) { GrantFront::Policy.all.first }
+    let(:klass) {GrantFront::Policy.all.first.klass}
 
     it "returns some methods" do
-      expect(GrantFront::Policy.find(policy)[:methods].keys).to eq([:create, :update, :destroy])
+      expect(GrantFront::Policy.find(klass).methods.keys).to eq([:create, :update, :destroy])
     end
 
     it "returns some roles" do
-      expect(GrantFront::Policy.find(policy)[:roles]).to eq([:foo, :bar, :baz])
+      expect(GrantFront::Policy.find(klass).roles).to eq([:foo, :bar, :baz])
     end
   end
 end

data/spec/lib/version_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe "GrantFront::VERSION" do
-  describe "VERSION" do
+  describe "reference" do
     it "returns #{GrantFront::VERSION} version" do
       expect(GrantFront::VERSION).to eq(GrantFront::VERSION)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grant-front
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - ogom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -89,6 +89,7 @@ files:
 - lib/tasks/grant-front.rake
 - lib/templates/layouts/application.html.erb
 - spec/grant-front_spec.rb
+- spec/lib/diagram_spec.rb
 - spec/lib/policy_spec.rb
 - spec/lib/version_spec.rb
 - spec/spec_helper.rb
@@ -118,6 +119,7 @@ specification_version: 4
 summary: Authorization Grant Front.
 test_files:
 - spec/grant-front_spec.rb
+- spec/lib/diagram_spec.rb
 - spec/lib/policy_spec.rb
 - spec/lib/version_spec.rb
 - spec/spec_helper.rb