admission 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6fc32c93d1bd50bfe3cea39b1e7e62be2add21e
-  data.tar.gz: '095f27c6a9e95f503954ff5bea97ae12c828ef8f'
+  metadata.gz: 4eb5d14f7cda027b322111bf9f1e065063510222
+  data.tar.gz: 80dabfdd53d16c0300a53d2aea8aee8e93e5e2c7
 SHA512:
-  metadata.gz: e46fdce9e3feea2f4c99c7d38a9ef606499f19fac82491644c82625da439b0337392d04e731e6ce2e9efd6f6ae97ddadef5c9f267df8d643432d2fccb8827c95
-  data.tar.gz: daefd3683677ec4ff98f1c8a5bb2147baf44d8690423024954a78859aa45fdbce73a26ae81ee9ad16b297b1127a3005202efa927748fd49501f345f3c10cd939
+  metadata.gz: 35eed6cd8fcc1219ef8e9073f1b790ecdea387550c8abfb158777e9c8afea4fde0340e08729b1460c366fea9c2651287b6b98f2555b2c884dcec63dd73ac3aab
+  data.tar.gz: bd0badfc8814b1dadaa883188ddfc2bfb110a9727b552140c3a54803577f6639cd08f58bb78b0713eda310617c5328075e34ecfd072bdad78391baafc4bc76b3

data/.gitignore

@@ -34,4 +34,7 @@ Gemfile.lock
 
 ## Specific for InteliJ:
 /.idea
-*.iml
+*.iml
+
+/visualisation/node_modules
+/visualisation/build

data/Gemfile

@@ -3,4 +3,8 @@ source "https://rubygems.org"
 
 gem 'rspec'
 # gem 'mutant-rspec'
-gem 'byebug'
+gem 'byebug'
+
+gem 'sinatra', '~> 2.0'
+gem 'sinatra-contrib'
+gem 'haml'

data/bin/server.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+
+require 'rack'
+require 'byebug'
+
+require_relative '../lib/admission'
+require_relative '../lib/admission/visualisation'
+require_relative '../spec/test_context/index'
+
+Admission::Visualisation.set :js_entry,
+    Admission::Visualisation::ASSETS_PATH.join('build', 'admission_visualisation.js')
+
+Admission::Visualisation.set :admission_data,
+    {
+        order: PRIVILEGES_ORDER,
+        rules: ACTIONS_RULES,
+        arbitrator: Admission::Arbitration
+    }
+
+
+Rack::Handler::WEBrick.run Admission::Visualisation

data/lib/admission/arbitration.rb

@@ -5,9 +5,11 @@ class Admission::Arbitration
     @person = person
     @rules_index = rules_index
     @request = request.to_sym
+    @decisions = {}
   end
 
   def prepare_sitting context=nil
+    return if context == @context
     @context = context
     @decisions = {}
   end

data/lib/admission/privilege.rb

@@ -30,6 +30,12 @@ class Admission::Privilege
     hash == other.hash
   end
 
+  def eql_or_inherits? sought
+    return true if eql? sought
+    return false unless inherited
+    inherited.any?{|pi| pi.eql_or_inherits? sought}
+  end
+
   def text_key
     level == BASE_LEVEL_NAME ? name.to_s : "#{name}-#{level}"
   end

data/lib/admission/resource_arbitration.rb

@@ -5,6 +5,7 @@ class Admission::ResourceArbitration < Admission::Arbitration
     scope, @resource = scope_and_resource scope_or_resource
     @rules_index = rules_index[scope] || {}
     @request = request.to_sym
+    @decisions = {}
   end
 
   def make_decision from_rules, privilege

data/lib/admission/status.rb

@@ -4,13 +4,25 @@ class Admission::Status
 
   def initialize person, privileges, rules, arbiter
     @person = person
-    @privileges = (privileges.nil? || privileges.empty?) ? nil : privileges
     @rules = rules
     @arbiter = arbiter
+
+    @privileges = if privileges.nil? || privileges.empty?
+      nil
+
+    else
+      grouped = privileges.inject Hash.new do |h, p|
+        hash = p.context.hash rescue nil.hash
+        (h[hash] ||= []) << p
+        h
+      end
+
+      grouped.values.flatten.freeze
+    end
   end
 
   def can? *args
-    return false unless @privileges
+    return false unless privileges
     process_request @arbiter.new(person, rules, *args)
   end
 
@@ -26,11 +38,18 @@ class Admission::Status
     end
   end
 
+  def has? sought
+    return false unless privileges
+
+    list = privilege.context ? privileges.select{|p| p.context == privilege.context} : privileges
+    list.any?{|p| p.eql_or_inherits? sought}
+  end
+
   def allowed_in_contexts *args
-    return [] unless @privileges
+    return [] unless privileges
     arbitration = @arbiter.new person, rules, *args
 
-    @privileges.reduce [] do |list, privilege|
+    privileges.reduce [] do |list, privilege|
       context = privilege.context
 
       unless list.include? context

data/lib/admission/version.rb

@@ -1,3 +1,3 @@
 module Admission
-  VERSION = '0.1.9'
+  VERSION = '0.2.0'
 end

data/lib/admission/visualisation.rb

@@ -0,0 +1,81 @@
+require 'sinatra/base'
+require 'sinatra/json'
+require 'haml'
+require 'pathname'
+
+class Admission::Visualisation < Sinatra::Base
+  ASSETS_PATH = Pathname.new(__FILE__).join('..', '..', '..', 'visualisation')
+
+  enable :inline_templates
+
+  set :js_entry, ASSETS_PATH.join('dist', 'admission_visualisation.js')
+
+  get '/' do
+    haml :index
+  end
+
+  get '/admission_visualisation.js' do
+    send_file settings.js_entry
+  end
+
+  get '/admission_data' do
+    json Admission::Visualisation.admission_data_to_js(
+        **settings.admission_data)
+  end
+
+  def self.admission_data_to_js order:, rules:, arbitrator:, **_
+    js_data = {}
+
+    top_levels = []
+    privileges = order.values.inject Array.new do |arr, levels|
+      tops, others = levels.to_a.partition{|key, _| key == :'^'}
+      tops.first[1].tap{|privilege| top_levels << privilege.text_key}
+
+      others.each do |_, privilege|
+        arr << {name: privilege.name, level: privilege.level,
+            inherits: privilege.inherited && privilege.inherited.map(&:text_key)}
+      end
+
+      arr
+    end
+    js_data[:top_levels] = top_levels
+    js_data[:privileges] = privileges
+
+    rules = if arbitrator == Admission::Arbitration
+      rules.to_a.map do |scope, index|
+
+        index = index.to_a.map do |privilege, rule|
+          if rule.is_a? Proc
+            rule = 'proc'
+          end
+
+          [privilege.text_key, rule]
+        end
+
+        [scope, Hash[index]]
+      end
+
+    else
+      raise "not implemented for #{arbitrator.name}"
+
+    end
+    js_data[:rules] = Hash[rules]
+
+    js_data
+  end
+
+end
+
+__END__
+
+@@ layout
+!!! 5
+%html
+  %head
+    %title= 'Admission'
+  %body.flex-column
+    = yield
+
+@@ index
+#admission-visualisation(data-url="/admission_data")
+%script(src="/admission_visualisation.js")

data/spec/integration/resource_arbitrating_spec.rb

@@ -22,7 +22,6 @@ RSpec.describe 'resources_arbitrating' do
   end
 
   def rule scope, action, privilege
-    byebug if $bug
     arbitration(scope, action, privilege.context).rule_per_privilege privilege
   end
 

data/spec/test_context/privileges_and_rules.rb

@@ -2,7 +2,7 @@
 
 PRIVILEGES_ORDER = Admission::Privilege.define_order do
   privilege :vassal,   levels: %i[lord]
-  privilege :human,      levels: %i[count king]
+  privilege :human,    levels: %i[count king]
   privilege :emperor,  inherits: %i[vassal human]
 end
 

data/spec/unit/privilege_spec.rb

@@ -68,6 +68,33 @@ RSpec.describe Admission::Privilege do
   end
 
 
+  describe '#eql_or_inherits?' do
+
+    it 'returns true since it equals sought privilege' do
+      expect(privilege.eql_or_inherits? privilege).to eq(true)
+    end
+
+    it 'return false when does not inherit any' do
+      expect(privilege_superman.eql_or_inherits? privilege_uberman).to eq(false)
+    end
+
+    it 'finds nested inherited privilege and therefore evaluates to true' do
+      top_privilege = new_privilege 'man', 'top'
+      top_privilege.inherits_from new_privilege('man', 'branch'),
+          new_privilege('man', 'middle').tap{|p| p.inherits_from new_privilege('man')}
+
+      sought = new_privilege 'man'
+      expect(top_privilege.eql_or_inherits? sought).to eq(true)
+      expect(top_privilege.eql_or_inherits? new_privilege('man', 'nope')).to eq(false)
+    end
+
+    it 'ignores context' do
+      expect(privilege.eql_or_inherits? privilege.dup_with_context(:czech)).to eq(true)
+    end
+
+  end
+
+
   describe '#to_s' do
 
     it 'prints name and level' do

data/spec/unit/status_spec.rb

@@ -27,14 +27,32 @@ RSpec.describe Admission::Status do
       )
     end
 
-    it 'sets privileges' do
-      instance = Admission::Status.new :person, ['kkk'], :rules, :arbiter
+    it 'sets privileges and freezes them' do
+      instance = Admission::Status.new :person, [:czech], :rules, :arbiter
       expect(instance).to have_inst_vars(
           person: :person,
-          privileges: ['kkk'],
+          privileges: [:czech],
           rules: :rules,
           arbiter: :arbiter
       )
+      expect(instance.privileges).to be_frozen
+    end
+
+    it 'sorts privileges by context' do
+      instance = Admission::Status.new :person, [
+          privilege(nil),
+          privilege(:czech),
+          privilege(15),
+          privilege(:czech),
+          privilege({a: 15}),
+          privilege({a: {f: 1}}),
+          privilege(nil),
+          privilege({a: 15}),
+      ], :rules, :arbiter
+      expect(instance.privileges.map(&:context)).to eq([
+          nil, nil, :czech, :czech, 15, {:a=>15}, {:a=>15}, {:a=>{:f=>1}}
+      ])
+      expect(instance.privileges).to be_frozen
     end
 
   end

data/visualisation/.babelrc

@@ -0,0 +1,7 @@
+{
+  //  "sourceMaps": true,
+  "presets": ["es2015"],
+  "plugins": [
+    ["transform-react-jsx", { "pragma": "preact.h" }]
+  ]
+}

data/visualisation/components/app_container.jsx

@@ -0,0 +1,73 @@
+import preact from 'preact';
+import PrivilegesPanel from './privileges_panel';
+import classnames from 'classnames';
+
+export default class AppContainer extends preact.Component {
+
+    constructor (props) {
+        super(props);
+
+        this.switchToPrivileges = this.changePanel.bind(this, 'privileges');
+        this.switchToRules = this.changePanel.bind(this, 'rules');
+    }
+
+    render ({app}, {loaded, load_fail, panel}) {
+        if (!loaded) return <div className="splash-message">
+            <code>... loading admission data ...</code>
+        </div>;
+
+        if (load_fail) return <div className="splash-message">
+            <h4>failed to load admission data</h4>
+            <code>{load_fail}</code>
+        </div>;
+
+        return <div>
+            <ul className="panels-list">
+
+                <li
+                    onClick={this.switchToPrivileges}
+                    className={classnames({'active': panel === 'privileges'})}>
+                    Privileges Order
+                </li>
+
+                <li
+                    onClick={this.switchToRules}
+                    className={classnames({'active': panel === 'rules'})}>
+                    Rules Listing
+                </li>
+
+            </ul>
+
+            {this.renderPanel()}
+        </div>;
+    }
+
+    componentDidMount () {
+        const store = this.props.app.store;
+
+        this.store_unsibscribe = store.subscribe(() => {
+            const state = store.getState();
+            this.setState({loaded: state.loaded, panel: state.panel});
+        });
+
+        setTimeout(this.props.onMounted, 0);
+    }
+
+    componentWillUnmount () {
+        this.store_unsibscribe();
+    }
+
+    changePanel(panel) {
+        this.props.app.store.dispatch({type: 'PANEL_CHANGE', panel: panel});
+    }
+
+    renderPanel () {
+        const app = this.props.app;
+        switch (this.state.panel) {
+            case 'privileges':
+                return <PrivilegesPanel app={app} />;
+                break;
+
+        }
+    }
+}

data/visualisation/components/input_with_select.jsx

@@ -0,0 +1,164 @@
+import preact from 'preact';
+import classnames from 'classnames';
+
+export default class InputWithSelect extends preact.Component {
+
+    constructor (props) {
+        super(props);
+
+        this.state = {
+            text: props.defaultText || '',
+            matching: null,
+        };
+
+        this.setParentRef = ref => this.element = ref;
+        this.setListRef = ref => this.list = ref;
+        this.onKeyDown = props.app.debounce(this.onKeyDown.bind(this), 200);
+        this.toggleList = props.app.debounce(this.toggleList.bind(this), 400, true);
+        this.closeList = this.closeList.bind(this);
+        this.onSelected = this.onSelected.bind(this);
+    }
+
+    render ({app, placeholder}, {text, matching}) {
+        if (!matching) this.list = null;
+
+        return <div
+            ref={this.setParentRef}
+            className="controls-select">
+
+            <div className="_inputs">
+                <input
+                    type="text"
+                    className="input_text"
+                    placeholder={placeholder}
+                    onKeyDown={this.onKeyDown}
+                    value={text}/>
+
+                <button
+                    tabIndex="-1"
+                    className="button"
+                    onClick={this.toggleList}>
+                    &#8964;
+                </button>
+            </div>
+
+            {matching && <DropdownList
+                ref={this.setListRef}
+                app={app}
+                items={matching}
+                toSelect={this.onSelected}
+                toClose={this.closeList}
+            />}
+
+        </div>;
+    }
+
+    componentDidMount () {
+        this._outside_click_listener = e => {
+            if (!this.element.contains(e.target) && this.list) {
+                this.closeList();
+            }
+        };
+        document.addEventListener('click', this._outside_click_listener);
+    }
+
+    componentWillUnmount () {
+        document.removeEventListener('click', this._outside_click_listener);
+    }
+
+    componentWillReceiveProps (new_props) {
+        if (new_props.defaultText !== this.props.defaultText) this.setState({text: new_props.defaultText});
+    }
+
+    onKeyDown (e) {
+        if (this.list && this.list.onKeyDown(e)) return;
+
+        const text = e.target.value.trim();
+        let matching = null;
+        if ((text && text !==this.state.text) || e.keyCode === 40) {
+            matching = filter_items(this.props.all_items, text);
+        }
+        this.setState({matching, text});
+    }
+
+    toggleList () {
+        if (this.list) {
+            this.closeList();
+
+        } else {
+            this.setState({matching: this.props.all_items});
+        }
+    }
+
+    closeList () {
+        this.setState({matching: null});
+    }
+
+    onSelected (value) {
+        this.setState({text: value, matching: null});
+        this.props.onSelect(value);
+    }
+
+}
+
+class DropdownList extends preact.Component {
+
+    constructor (props) {
+        super(props);
+        this.state = {selected: -1};
+    }
+
+    render ({app, items, toSelect}, {selected}) {
+        return <div
+            className="_dropdown">
+            <ul>
+                {items.map((name, i) => <li
+                    className={classnames({'selected': selected === i})}
+                    onClick={() => toSelect(name)}>
+                    {name}
+                </li>)}
+            </ul>
+        </div>;
+    }
+
+    onKeyDown (e) {
+        switch (e.keyCode) {
+            case 40: // down
+                this.changeSelection(1);
+                return true;
+                break;
+
+            case 38: // up
+                this.changeSelection(-1);
+                return true;
+                break;
+
+            case 13: // enter
+                const selected = this.state.selected;
+                if (selected !== -1) this.props.toSelect(this.props.items[selected]);
+                return true;
+                break;
+
+            case 27: // escape
+                this.props.toClose();
+                return true;
+                break;
+
+        }
+        return false;
+    }
+
+    changeSelection (value) {
+        let selected = this.state.selected;
+        selected += value;
+        if (selected < 0) selected = 0;
+        if (selected >= this.props.items.length) selected = this.props.items.length -1;
+        this.setState({selected});
+    }
+}
+
+function filter_items (all, input_text) {
+    let items = all.filter(value => value.startsWith(input_text));
+    if (items.length === 0) items = null;
+    return items;
+}