action_policy 0.4.4 → 0.5.0

data/docs/_sidebar.md

@@ -1,27 +0,0 @@
-* Getting Started
-  * [Quick Start](quick_start.md)
-  * [Writing Policies](writing_policies.md)
-  * [Rails Integration](rails.md)
-  * [Non-Rails Usage](non_rails.md)
-  * [GraphQL Integration](graphql.md)
-  * [Testing](testing.md)
-* Features
-  * [Authorization Behaviour](behaviour.md)
-  * [Policy Lookup](lookup_chain.md)
-  * [Authorization Context](authorization_context.md)
-  * [Aliases](aliases.md)
-  * [Pre-Checks](pre_checks.md)
-  * [Scoping](scoping.md)
-  * [Caching](caching.md)
-  * [Namespaces](namespaces.md)
-  * [Failure Reasons](reasons.md)
-  * [Instrumentation](instrumentation.md)
-  * [I18n Support](i18n.md)
-  * [Debugging](debugging.md)
-* Tips & Tricks
-  * [From Pundit to Action Policy](./pundit_migration.md)
-  * [Dealing with Decorators](./decorators.md)
-  * [Controller Action Aliases](controller_action_aliases.md)
-* Customize
-  * [Base Policy](custom_policy.md)
-  * [Lookup Chain](custom_lookup_chain.md)

data/docs/aliases.md

@@ -1,122 +0,0 @@
-# Rule Aliases
-
-Action Policy allows you to add rule aliases. It is useful when you rely on _implicit_ rules in controllers. For example:
-
-```ruby
-class PostsController < ApplicationController
-  before_action :load_post, only: [:edit, :update, :destroy]
-
-  private
-
-  def load_post
-    @post = Post.find(params[:id])
-    # depending on action, an `edit?`, `update?` or `destroy?`
-    # rule would be applied
-    authorize! @post
-  end
-end
-```
-
-In your policy, you can create aliases to avoid duplication:
-
-```ruby
-class PostPolicy < ApplicationPolicy
-  alias_rule :edit?, :destroy?, to: :update?
-end
-```
-
-**NOTE**: `alias_rule` is available only if you inherit from `ActionPolicy::Base` or include `ActionPolicy::Policy::Aliases` into your `ApplicationPolicy`.
-
-**Why not just use Ruby's `alias`?**
-
-An alias created with `alias_rule` is resolved at _authorization time_ (during an `authorize!` or `allowed_to?` call), and it does not add an alias method to the class.
-
-That allows us to write tests easier, as we should only test the rule, not the alias–and to leverage [caching](caching.md) better.
-
-By default, `ActionPolicy::Base` adds one alias: `alias_rule :new?, to: :create?`.
-
-## Default rule
-
-You can add a _default_ rule–the rule that would be applied if the rule specified during authorization is missing (like a "wildcard" alias):
-
-```ruby
-class PostPolicy < ApplicationPolicy
-  # For an ApplicationPolicy, makes :manage? match anything that is
-  # not :index?, :create? or :new?
-  default_rule :manage?
-
-  # If you want manage? to catch really everything, place this alias
-  #alias_rule :index?, :create?, :new?, to: :manage?
-  def manage?
-    # ...
-  end
-end
-```
-
-Now when you call `authorize! post` with any rule not defined in the policy class, the `manage?` rule is applied.  Note that `index?` `create?` and `new?` are already defined in the [superclass by default](custom_policy.md) (returning `false`) - if you want the same behaviour for *all* actions, define aliases like in the example above (commented out).
-
-By default, `ActionPolicy::Base` sets `manage?` as a default rule.
-
-## Aliases and Private Methods
-
-Rules in `action_policy` can only be public methods. Trying to use a private method as a rule will raise an error. Thus, aliases can also only point to public methods.
-
-## Rule resolution with subclasses
-
-Here's the order in which aliases and concrete rule methods are resolved in regards to subclasses:
-
-1. If there is a concrete rule method on the subclass, this is called, else
-2. If there is a matching alias then this is called, else
-  * When aliases are defined on the subclass they will overwrite matching aliases on the superclass.
-3. If there is a concrete rule method on the superclass, then this is called, else
-4. If there is a default rule defined, then this is called, else
-5. `ActionPolicy::UnknownRule` is raised.
-
-Here's an example with the expected results:
-
-```ruby
-class SuperPolicy < ApplicationPolicy
-  default_rule :manage?
-
-  alias_rule :update?, :destroy?, :create?, to: :edit?
-
-  def manage?
-  end
-
-  def edit?
-  end
-
-  def index?
-  end
-end
-
-class SubPolicy < AbstractPolicy
-  default_rule nil
-
-  alias_rule :index?, :update?, to: :manage?
-
-  def create?
-  end
-end
-```
-
-Authorizing against the SuperPolicy:
-
-* `update?` will resolve to `edit?`
-* `destroy?` will resolve to `edit?`
-* `create?` will resolve to `edit?`
-* `manage?` will resolve to `manage?`
-* `edit?` will resolve to `edit?`
-* `index?` will resolve to `index?`
-* `something?` will resolve to `manage?`
-
-Authorizing against the SubPolicy:
-
-* `index?` will resolve to `manage?`
-* `update?` will resolve to `manage?`
-* `create?` will resolve to `create?`
-* `destroy?` will resolve to `edit?`
-* `manage?` will resolve to `manage?`
-* `edit?` will resolve to `edit?`
-* `index?` will resolve to `manage?`
-* `something?` will raise `ActionPolicy::UnknownRule`

data/docs/assets/docsify-search.js

@@ -1,364 +0,0 @@
-(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);
-  
-  }());
-