action_policy 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e593d4567bab1e7fec960db2d67d7d659d4b4df92159741b7db715b35b75c790
-  data.tar.gz: efdc9d9815936a6dcbb0e94b0098050bc30fddae20a3d06f35bf03b91787d500
+  metadata.gz: 998666ad64277112c6ddc44e6db9e0aa81b6bbf32994fb675797bcd8e1f9ca70
+  data.tar.gz: 5a35c722589841c6b41d6efd1735abe63833db03b9a7aec23e798648a97c5470
 SHA512:
-  metadata.gz: c58c58e14c25f4daadc890ab67de43781f33f28485811b05458568b9003b9037911fbaade9332dca0b458dec811138df87fa094564574cd55fae948a09379be8
-  data.tar.gz: 12db66ef181fa94ec6ac2c48feeb7fe49d12a3b66a9a554c925594b9b622ec3cec94412e48db13406d71733d0ae001f7dece5fedfe56ca11216f6e027754765f
+  metadata.gz: 03a5594069a5947566708f3b3ad419d79be8931d38c25195f754d1474fa9b2f3bcf5e0f9e520a828d56c1fcfac762929ae4fdcf852c657f4b6bec973c0559e0b
+  data.tar.gz: e41e88d916fdf0832e7b03cdadcf7f6c1a4814c45e6ca76e12094bbcb03a6ea54146a0e676d079a0813caff31f54c3dfe90d0e917ade8c4261e17ec4d55a4221

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## master
 
+## 0.3.2 (2019-05-26) 👶
+
+- Fixed thread-safety issues with scoping configs. ([@palkan][])
+
+  Fixes [#75](https://github.com/palkan/action_policy/issues/75).
+
 ## 0.3.1 (2019-05-30)
 
 - Fixed bug with missing implicit target and hash like scoping data. ([@palkan][])

data/README.md

@@ -4,7 +4,9 @@
 
 # ActionPolicy
 
-Action Policy is an authorization framework for Ruby and Rails applications.
+Authorization framework for Ruby and Rails applications.
+
+Composable. Extensible. Performant.
 
 📑 [Documentation](https://actionpolicy.evilmartians.io)
 

data/docs/README.md

@@ -3,7 +3,8 @@
 
 ## Action Policy
 
-> Action Policy is an authorization framework for Ruby and Rails applications.
+> Authorization framework for Ruby and Rails.
+<br>Composable. Extensible. Performant.
 
 **NOTE:** this documentation is for the version "0.3.0+".
 
@@ -20,6 +21,12 @@ Action Policy provides flexible tools to build an _authorization layer_ for your
 
 **NOTE:** Action Policy does not force you to use a specific authorization model (i.e., roles, permissions, etc.) and does not provide one. It only answers a single question: **How to verify access?**
 
+## Where to go from here?
+- [Quick start](./quick_start.md)
+- [Using with Rails](./rails.md)
+- [Using with other Ruby frameworks](./non_rails.md)
+- [Using with GraphQL Ruby](./graphql.md)
+
 ## Project State
 
 The project is being used in production since mid 2018. Major features have been implemented, API has been stabilized. Check out our [development board](https://github.com/palkan/action_policy/projects/1) to see what's coming next.

data/docs/assets/docsify-search.js

@@ -0,0 +1,364 @@
+(function () {
+  var INDEXS = {};
+  
+  var LOCAL_STORAGE = {
+    EXPIRE_KEY: 'docsify.search.expires',
+    INDEX_KEY: 'docsify.search.index'
+  };
+  
+  function resolveExpireKey(namespace) {
+    return namespace ? ((LOCAL_STORAGE.EXPIRE_KEY) + "/" + namespace) : LOCAL_STORAGE.EXPIRE_KEY
+  }
+  function resolveIndexKey(namespace) {
+    return namespace ? ((LOCAL_STORAGE.INDEX_KEY) + "/" + namespace) : LOCAL_STORAGE.INDEX_KEY
+  }
+  
+  function escapeHtml(string) {
+    var entityMap = {
+      '&': '&',
+      '<': '&lt;',
+      '>': '&gt;',
+      '"': '&quot;',
+      '\'': '&#39;',
+      '/': '&#x2F;'
+    };
+  
+    return String(string).replace(/[&<>"'/]/g, function (s) { return entityMap[s]; })
+  }
+  
+  function getAllPaths(router) {
+    var paths = [];
+  
+    Docsify.dom.findAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(function (node) {
+      var href = node.href;
+      var originHref = node.getAttribute('href');
+      var path = router.parse(href).path;
+  
+      if (
+        path &&
+        paths.indexOf(path) === -1 &&
+        !Docsify.util.isAbsolutePath(originHref)
+      ) {
+        paths.push(path);
+      }
+    });
+  
+    return paths
+  }
+  
+  function saveData(maxAge, expireKey, indexKey) {
+    localStorage.setItem(expireKey, Date.now() + maxAge);
+    localStorage.setItem(indexKey, JSON.stringify(INDEXS));
+  }
+  
+  function genIndex(path, content, router, depth) {
+    if ( content === void 0 ) content = '';
+  
+    var tokens = window.marked.lexer(content);
+    var slugify = window.Docsify.slugify;
+    var index = {};
+    var slug;
+  
+    tokens.forEach(function (token) {
+      if (token.type === 'heading' && token.depth <= depth) {
+        slug = router.toURL(path, {id: slugify(token.text)});
+        index[slug] = {slug: slug, title: token.text, body: ''};
+      } else {
+        if (!slug) {
+          return
+        }
+        if (!index[slug]) {
+          index[slug] = {slug: slug, title: '', body: ''};
+        } else if (index[slug].body) {
+          index[slug].body += '\n' + (token.text || '');
+        } else {
+          index[slug].body = token.text;
+        }
+      }
+    });
+    slugify.clear();
+    return index
+  }
+  
+  /**
+   * @param {String} query
+   * @returns {Array}
+   */
+  function search(query) {
+    var matchingResults = [];
+    var data = [];
+    Object.keys(INDEXS).forEach(function (key) {
+      data = data.concat(Object.keys(INDEXS[key]).map(function (page) { return INDEXS[key][page]; }));
+    });
+  
+    query = query.trim();
+    var keywords = query.split(/[\s\-，\\/]+/);
+    if (keywords.length !== 1) {
+      keywords = [].concat(query, keywords);
+    }
+  
+    var loop = function ( i ) {
+      var post = data[i];
+      var matchesScore = 0;
+      var resultStr = '';
+      var postTitle = post.title && post.title.trim();
+      var postContent = post.body && post.body.trim();
+      var postUrl = post.slug || '';
+  
+      if (postTitle) {
+        keywords.forEach( function (keyword) {
+          // From https://github.com/sindresorhus/escape-string-regexp
+          var regEx = new RegExp(
+            keyword.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&'),
+            'gi'
+          );
+          var indexTitle = -1;
+          var indexContent = -1;
+  
+          indexTitle = postTitle ? postTitle.search(regEx) : -1;
+          indexContent = postContent ? postContent.search(regEx) : -1;
+  
+          if (indexTitle >= 0 || indexContent >= 0) {
+            matchesScore += indexTitle >= 0 ? 3 : indexContent >= 0 ? 2 : 0;
+            if (indexContent < 0) {
+              indexContent = 0;
+            }
+  
+            var start = 0;
+            var end = 0;
+  
+            start = indexContent < 11 ? 0 : indexContent - 10;
+            end = start === 0 ? 70 : indexContent + keyword.length + 60;
+  
+            if (end > postContent.length) {
+              end = postContent.length;
+            }
+  
+            var matchContent =
+              '...' +
+              escapeHtml(postContent)
+                .substring(start, end)
+                .replace(regEx, ("<em class=\"search-keyword\">" + keyword + "</em>")) +
+              '...';
+  
+            resultStr += matchContent;
+          }
+        });
+  
+        if (matchesScore > 0) {
+          var matchingPost = {
+            title: escapeHtml(postTitle),
+            content: postContent ? resultStr : '',
+            url: postUrl,
+            score: matchesScore
+          };
+  
+          matchingResults.push(matchingPost);
+        }
+      }
+    };
+  
+    for (var i = 0; i < data.length; i++) loop( i );
+  
+    return matchingResults.sort(function (r1, r2) { return r2.score - r1.score; });
+  }
+  
+  function init$1(config, vm) {
+    var isAuto = config.paths === 'auto';
+  
+    var expireKey = resolveExpireKey(config.namespace);
+    var indexKey = resolveIndexKey(config.namespace);
+  
+    var isExpired = localStorage.getItem(expireKey) < Date.now();
+  
+    INDEXS = JSON.parse(localStorage.getItem(indexKey));
+  
+    if (isExpired) {
+      INDEXS = {};
+    } else if (!isAuto) {
+      return
+    }
+  
+    var paths = isAuto ? getAllPaths(vm.router) : config.paths;
+    var len = paths.length;
+    var count = 0;
+  
+    paths.forEach(function (path) {
+      if (INDEXS[path]) {
+        return count++
+      }
+  
+      Docsify
+        .get(vm.router.getFile(path), false, vm.config.requestHeaders)
+        .then(function (result) {
+          INDEXS[path] = genIndex(path, result, vm.router, config.depth);
+          len === ++count && saveData(config.maxAge, expireKey, indexKey);
+        });
+    });
+  }
+  
+  var NO_DATA_TEXT = '';
+  var options;
+  
+  function style() {
+    var code = "\n.sidebar {\n  padding-top: 0;\n}\n\n.search {\n  margin-bottom: 20px;\n  padding: 6px;\n  border-bottom: 1px solid #eee;\n}\n\n.search .input-wrap {\n  display: flex;\n  align-items: center;\n}\n\n.search .results-panel {\n  display: none;\n}\n\n.search .results-panel.show {\n  display: block;\n}\n\n.search input {\n  outline: none;\n  border: none;\n  width: 100%;\n  padding: 0 7px;\n  line-height: 36px;\n  font-size: 14px;\n}\n\n.search input::-webkit-search-decoration,\n.search input::-webkit-search-cancel-button,\n.search input {\n  -webkit-appearance: none;\n  -moz-appearance: none;\n  appearance: none;\n}\n.search .clear-button {\n  width: 36px;\n  text-align: right;\n  display: none;\n}\n\n.search .clear-button.show {\n  display: block;\n}\n\n.search .clear-button svg {\n  transform: scale(.5);\n}\n\n.search h2 {\n  font-size: 17px;\n  margin: 10px 0;\n}\n\n.search a {\n  text-decoration: none;\n  color: inherit;\n}\n\n.search .matching-post {\n  border-bottom: 1px solid #eee;\n}\n\n.search .matching-post:last-child {\n  border-bottom: 0;\n}\n\n.search p {\n  font-size: 14px;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  display: -webkit-box;\n  -webkit-line-clamp: 2;\n  -webkit-box-orient: vertical;\n}\n\n.search p.empty {\n  text-align: center;\n}\n\n.app-name.hide, .sidebar-nav.hide {\n  display: none;\n}";
+  
+    Docsify.dom.style(code);
+  }
+  
+  function tpl(defaultValue) {
+    if ( defaultValue === void 0 ) defaultValue = '';
+  
+    var html =
+      "<div class=\"input-wrap\">\n      <input type=\"search\" value=\"" + defaultValue + "\" />\n      <div class=\"clear-button\">\n        <svg width=\"26\" height=\"24\">\n          <circle cx=\"12\" cy=\"12\" r=\"11\" fill=\"#ccc\" />\n          <path stroke=\"white\" stroke-width=\"2\" d=\"M8.25,8.25,15.75,15.75\" />\n          <path stroke=\"white\" stroke-width=\"2\"d=\"M8.25,15.75,15.75,8.25\" />\n        </svg>\n      </div>\n    </div>\n    <div class=\"results-panel\"></div>\n    </div>";
+    var el = Docsify.dom.create('div', html);
+    var aside = Docsify.dom.find('aside');
+  
+    Docsify.dom.toggleClass(el, 'search');
+    Docsify.dom.before(aside, el);
+  }
+  
+  function doSearch(value) {
+    var $search = Docsify.dom.find('div.search');
+    var $panel = Docsify.dom.find($search, '.results-panel');
+    var $clearBtn = Docsify.dom.find($search, '.clear-button');
+    var $sidebarNav = Docsify.dom.find('.sidebar-nav');
+    var $appName = Docsify.dom.find('.app-name');
+  
+    if (!value) {
+      $panel.classList.remove('show');
+      $clearBtn.classList.remove('show');
+      $panel.innerHTML = '';
+  
+      if (options.hideOtherSidebarContent) {
+        $sidebarNav.classList.remove('hide');
+        $appName.classList.remove('hide');
+      }
+      return
+    }
+    var matchs = search(value);
+  
+    var html = '';
+    matchs.forEach(function (post) {
+      html += "<div class=\"matching-post\">\n<a href=\"" + (post.url) + "\">\n<h2>" + (post.title) + "</h2>\n<p>" + (post.content) + "</p>\n</a>\n</div>";
+    });
+  
+    $panel.classList.add('show');
+    $clearBtn.classList.add('show');
+    $panel.innerHTML = html || ("<p class=\"empty\">" + NO_DATA_TEXT + "</p>");
+    if (options.hideOtherSidebarContent) {
+      $sidebarNav.classList.add('hide');
+      $appName.classList.add('hide');
+    }
+  }
+  
+  function bindEvents() {
+    var $search = Docsify.dom.find('div.search');
+    var $input = Docsify.dom.find($search, 'input');
+    var $inputWrap = Docsify.dom.find($search, '.input-wrap');
+  
+    var timeId;
+    // Prevent to Fold sidebar
+    Docsify.dom.on(
+      $search,
+      'click',
+      function (e) { return e.target.tagName !== 'A' && e.stopPropagation(); }
+    );
+    Docsify.dom.on($input, 'input', function (e) {
+      clearTimeout(timeId);
+      timeId = setTimeout(function (_) { return doSearch(e.target.value.trim()); }, 100);
+    });
+    Docsify.dom.on($inputWrap, 'click', function (e) {
+      // Click input outside
+      if (e.target.tagName !== 'INPUT') {
+        $input.value = '';
+        doSearch();
+      }
+    });
+  }
+  
+  function updatePlaceholder(text, path) {
+    var $input = Docsify.dom.getNode('.search input[type="search"]');
+  
+    if (!$input) {
+      return
+    }
+    if (typeof text === 'string') {
+      $input.placeholder = text;
+    } else {
+      var match = Object.keys(text).filter(function (key) { return path.indexOf(key) > -1; })[0];
+      $input.placeholder = text[match];
+    }
+  }
+  
+  function updateNoData(text, path) {
+    if (typeof text === 'string') {
+      NO_DATA_TEXT = text;
+    } else {
+      var match = Object.keys(text).filter(function (key) { return path.indexOf(key) > -1; })[0];
+      NO_DATA_TEXT = text[match];
+    }
+  }
+  
+  function updateOptions(opts) {
+    options = opts;
+  }
+  
+  function init(opts, vm) {
+    var keywords = vm.router.parse().query.s;
+  
+    updateOptions(opts);
+    style();
+    tpl(keywords);
+    bindEvents();
+    keywords && setTimeout(function (_) { return doSearch(keywords); }, 500);
+  }
+  
+  function update(opts, vm) {
+    updateOptions(opts);
+    updatePlaceholder(opts.placeholder, vm.route.path);
+    updateNoData(opts.noData, vm.route.path);
+  }
+  
+  var CONFIG = {
+    placeholder: 'Type to search',
+    noData: 'No Results!',
+    paths: 'auto',
+    depth: 2,
+    maxAge: 86400000, // 1 day
+    hideOtherSidebarContent: false,
+    namespace: undefined
+  };
+  
+  var install = function (hook, vm) {
+    var util = Docsify.util;
+    var opts = vm.config.search || CONFIG;
+  
+    if (Array.isArray(opts)) {
+      CONFIG.paths = opts;
+    } else if (typeof opts === 'object') {
+      CONFIG.paths = Array.isArray(opts.paths) ? opts.paths : 'auto';
+      CONFIG.maxAge = util.isPrimitive(opts.maxAge) ? opts.maxAge : CONFIG.maxAge;
+      CONFIG.placeholder = opts.placeholder || CONFIG.placeholder;
+      CONFIG.noData = opts.noData || CONFIG.noData;
+      CONFIG.depth = opts.depth || CONFIG.depth;
+      CONFIG.hideOtherSidebarContent = opts.hideOtherSidebarContent || CONFIG.hideOtherSidebarContent;
+      CONFIG.namespace = opts.namespace || CONFIG.namespace;
+    }
+  
+    var isAuto = CONFIG.paths === 'auto';
+  
+    hook.mounted(function (_) {
+      init(CONFIG, vm);
+      !isAuto && init$1(CONFIG, vm);
+    });
+    hook.doneEach(function (_) {
+      update(CONFIG, vm);
+      isAuto && init$1(CONFIG, vm);
+    });
+  };
+  
+  $docsify.plugins = [].concat(install, $docsify.plugins);
+  
+  }());
+  

data/docs/assets/styles.css

@@ -56,18 +56,23 @@ a {
   text-align: center;
 }
 
-
-aside.sidebar {
+.sidebar {
   border: none;
   background-color: var(--theme-color-secondary);
   color: #fff;
   width: 20%;
+  display: flex;
+  flex-direction: column;
 }
 
 body.close .sidebar {
   transform: translateX(-100%);
 }
 
+.sidebar .sidebar-nav {
+  order: 3;
+}
+
 .sidebar ul li a {
   color: rgba(255,255,255,0.8);
   color: var(--theme-color-light);
@@ -89,7 +94,32 @@ body.close .sidebar {
 }
 
 .sidebar > h1 {
+  order: 1;
   font-size: 2rem;
+  margin-top: 1.5rem;
+}
+
+/* search plugin related */
+
+.sidebar .search {
+  order: 2;
+  margin: 1.5rem 0 0 0;
+  border: none;
+  margin-top: 20px;
+  margin-bottom: 20px;
+  padding: 6px;
+}
+
+.sidebar .search .input-wrap {
+  border: none;
+  position: relative;
+}
+
+.sidebar .search .clear-button.show {
+  display: block;
+  position: absolute;
+  right: 4px;
+  top: 8px;
 }
 
 body .sidebar-toggle {

data/docs/custom_policy.md

@@ -12,6 +12,7 @@ class ActionPolicy::Base
   include ActionPolicy::Policy::PreCheck
   include ActionPolicy::Policy::Reasons
   include ActionPolicy::Policy::Aliases
+  include ActionPolicy::Policy::Scoping
   include ActionPolicy::Policy::Cache
   include ActionPolicy::Policy::CachedApply
   include ActionPolicy::Policy::Defaults

data/docs/decorators.md

@@ -15,7 +15,7 @@ module ActionPolicy
   module Draper
     def policy_for(record:, **opts)
       # From https://github.com/GoodMeasuresLLC/draper-cancancan/blob/master/lib/draper/cancancan.rb
-      record = record.model while record.is_a?(Draper::Decorator)
+      record = record.model while record.is_a?(::Draper::Decorator)
       super(record: record, **opts)
     end
   end

data/docs/index.html

@@ -30,10 +30,14 @@
       loadSidebar: true,
       subMaxLevel: 3,
       ga: 'UA-104346673-3',
-      auto2top:true
+      auto2top: true,
+      search: {
+        namespace: 'action-policy'
+      }
     }
   </script>
   <script src="assets/docsify.min.js"></script>
+  <script src="assets/docsify-search.js"></script>
   <script src="assets/prism-ruby.min.js"></script>
 </body>
 </html>

data/lib/action_policy.rb

@@ -13,7 +13,10 @@ module ActionPolicy
 
     def initialize(target, message = nil)
       @target = target
-      @message = message || "Couldn't find policy class for #{target.inspect}"
+      @message =
+        message ||
+        "Couldn't find policy class for #{target.inspect}" \
+        "#{target.is_a?(Module) ? "" : " (#{target.class})"}"
     end
   end
 

data/lib/action_policy/policy/scoping.rb

@@ -124,15 +124,14 @@ module ActionPolicy
         def scoping_handlers
           return @scoping_handlers if instance_variable_defined?(:@scoping_handlers)
 
-          @scoping_handlers = Hash.new { |h, k| h[k] = {} }
-
-          if superclass.respond_to?(:scoping_handlers)
-            superclass.scoping_handlers.each do |k, v|
-              @scoping_handlers[k] = v.dup
+          @scoping_handlers =
+            Hash.new { |h, k| h[k] = {} }.tap do |handlers|
+              if superclass.respond_to?(:scoping_handlers)
+                superclass.scoping_handlers.each do |k, v|
+                  handlers[k] = v.dup
+                end
+              end
             end
-          end
-
-          @scoping_handlers
         end
 
         # Define scope type matcher.
@@ -149,11 +148,12 @@ module ActionPolicy
         def scope_matchers
           return @scope_matchers if instance_variable_defined?(:@scope_matchers)
 
-          @scope_matchers = []
-
-          @scope_matchers = superclass.scope_matchers.dup if superclass.respond_to?(:scope_matchers)
-
-          @scope_matchers
+          @scope_matchers =
+            if superclass.respond_to?(:scope_matchers)
+              superclass.scope_matchers.dup
+            else
+              []
+            end
         end
       end
     end

data/lib/action_policy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionPolicy
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_policy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -165,6 +165,7 @@ files:
 - docs/README.md
 - docs/_sidebar.md
 - docs/aliases.md
+- docs/assets/docsify-search.js
 - docs/assets/docsify.min.js
 - docs/assets/fonts/FiraCode-Medium.woff
 - docs/assets/fonts/FiraCode-Regular.woff