strong_attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da121740cc4a0a6f17cb4f4c60d330c830a7b4de
+  data.tar.gz: 81639530a105615c335f1bda7bb9bc3d8640b0d3
+SHA512:
+  metadata.gz: c4f2d82dede1d5bbbb52bdf4e217eeac317b1840a17c1e2ed78965a23356a1b8a82b0bbe8b7f9f9b67764cdd91d8d84383c9294ba924ee405770765edf5782b1
+  data.tar.gz: d18af71fbf9a1e071cc16ad255b790ff3e774cd16faa2c485a5b850d0a4e6e26aa1fad49d9cea7387e0144ed269d89bb3bab6b79f0a85696b130f3b4afbc68da

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order rand

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - jruby-19mode
+

data/.yardopts

@@ -0,0 +1 @@
+yardoc 'lib/strong_presenter/**/*.rb' -m markdown --no-private

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# StrongAttributes Changelog
+
+## v0.0.1
+
+- code extracted from strong_presenter

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in strong_attributes.gemspec
+gemspec
+
+gem 'debugger', platforms: :mri_19
+gem 'byebug', platforms: :mri_20
+
+platforms :mri_19, :mri_20 do
+  gem 'simplecov', require: false
+  gem 'coveralls', require: false
+end
+

data/LICENSE

@@ -0,0 +1,179 @@
+Copyright (c) 2013 Ronald Ping Man Chan
+
+The Source Code Form referred to in this LICENSE file applies to all files stored within the same directory as this file, or in a subdirectory of the directory of this file, unless it is explicitly licensed or released otherwise. The official source of this software is found at https://github.com/ronalchn/.
+
+This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+=============================================
+A copy of the Mozilla Public License follows.
+=============================================
+
+Mozilla Public License
+Version 2.0
+
+1. Definitions
+
+1.1. “Contributor”
+means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software.
+
+1.2. “Contributor Version”
+means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor’s Contribution.
+
+1.3. “Contribution”
+means Covered Software of a particular Contributor.
+
+1.4. “Covered Software”
+means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof.
+
+1.5. “Incompatible With Secondary Licenses”
+means
+
+that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or
+
+that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License.
+
+1.6. “Executable Form”
+means any form of the work other than Source Code Form.
+
+1.7. “Larger Work”
+means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software.
+
+1.8. “License”
+means this document.
+
+1.9. “Licensable”
+means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License.
+
+1.10. “Modifications”
+means any of the following:
+
+any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or
+
+any new file in Source Code Form that contains any Covered Software.
+
+1.11. “Patent Claims” of a Contributor
+means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version.
+
+1.12. “Secondary License”
+means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses.
+
+1.13. “Source Code Form”
+means the form of the work preferred for making modifications.
+
+1.14. “You” (or “Your”)
+means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
+
+2. License Grants and Conditions
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and
+
+under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor:
+
+for any code that a Contributor has removed from Covered Software; or
+
+for infringements caused by: (i) Your and any other third party’s modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or
+
+under Patent Claims infringed by Covered Software in the absence of its Contributions.
+
+This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1.
+
+3. Responsibilities
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients’ rights in the Source Code Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and
+
+You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients’ rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+
+If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.
+
+5. Termination
+
+5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination.
+
+6. Disclaimer of Warranty
+
+Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer.
+
+7. Limitation of Liability
+
+Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party’s negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You.
+
+8. Litigation
+
+Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party’s ability to bring cross-claims or counter-claims.
+
+9. Miscellaneous
+
+This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached.
+

data/README.md

@@ -0,0 +1,29 @@
+# StrongAttributes
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'strong_attributes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strong_attributes
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task "default" => "ci"
+
+desc "Run all tests for CI"
+citask = ["spec"]
+begin
+  require 'coveralls/rake/task'
+  Coveralls::RakeTask.new
+  citask << "coveralls:push" if defined? 'Coveralls'
+rescue LoadError
+end
+task "ci" => citask
+
+desc "Run all specs"
+task "spec" => "spec:all"
+
+namespace "spec" do
+  task "all" => ["strong_attributes"]
+
+  def spec_task(name)
+    desc "Run #{name} specs"
+    RSpec::Core::RakeTask.new(name) do |t|
+      t.pattern = "spec/#{name}/**/*_spec.rb"
+    end
+  end
+
+  spec_task "strong_attributes"
+end
+

data/lib/strong_attributes/displayable.rb

@@ -0,0 +1,58 @@
+module StrongAttributes
+  module Displayable
+    extend ActiveSupport::Concern
+    include StrongAttributes::Permissible
+
+    # Displays the result of each method call if permitted. To permit all without checking, call `permit!` first.
+    #
+    # Calls and returns the result of each method call in the argument list. If a block is given, then each result
+    # is passed to the block.
+    #
+    #   user.displays :username, :email # returns [user.username, user.email]
+    #
+    # Or with two arguments, the name of the field is passed first:
+    #
+    #   <ul>
+    #     <% user.displays :username, :email, :address do |field, value| %>
+    #       <li><%= field.capitalize %>: <% value %></li>     
+    #     <% end %>
+    #   </ul>
+    #
+    # If only the presented value is desired, use `each`:
+    #
+    #   <% user.displays(:username, :email).each do |value| %>
+    #     <td><%= value %></td>
+    #   <% end %>
+    #
+    # Arguments can be included in an array:
+    #
+    #   user.displays :username, [:notifications, :unread] # returns [user.username, user.notifications(:unread)]
+    #
+    def displays *attributes
+      select_permitted(*attributes).map do |attribute|
+        args = Array(attribute).dup
+        value = self
+        until args.empty? do
+          arity = value.method(args[0]).arity
+          if arity >= 0
+            value = value.public_send *args.slice!(0, arity+1)
+          else
+            value = value.public_send *args
+            break
+          end
+        end
+        yield attribute, value if block_given?
+        value
+      end
+    end
+
+    # Same as displays, but for a single attribute. The differences are:
+    #   - the return value is not in an Array
+    #   - passes the value only (without attribute key as the 1st argument) to a block
+    def display field
+      displays field do |key, value|
+        yield value if block_given?
+      end.first
+    end
+  end
+end

data/lib/strong_attributes/permissible.rb

@@ -0,0 +1,50 @@
+module StrongAttributes
+  module Permissible
+    extend ActiveSupport::Concern
+
+    # Permits given attributes. May be invoked multiple times.
+    #
+    # @example Each argument represents a single attribute:
+    #   ArticlePresenter.new(@article).permit(:heading, :article)
+    #
+    # @example Attribute paths can be specified using symbol arrays. If an author name is normally accessed using @article.author.name:
+    #   ArticlePresenter.new(@article).permit([:author, :name])
+    #
+    # @param [[Symbols*]*] attribute_paths
+    #   the attributes to permit. An array of symbols represents an attribute path.
+    # @return [self]
+    def permit! *attribute_paths
+      permitted_attributes.permit *attribute_paths
+      self
+    end
+
+    # Permits all presenter attributes for presents, present & filter methods.
+    def permit_all!
+      permitted_attributes.permit_all!
+      self
+    end
+
+    # Selects the attributes given which have been permitted - an array of attributes
+    # @param [Array<Symbols>*] attribute_paths
+    #   the attribute paths to check. The attribute paths may also have arguments.
+    # @return [Array<Array<Symbol>>] attribute (paths)
+    def select_permitted *attribute_paths
+      permitted_attributes.select_permitted *attribute_paths
+    end
+
+    protected
+    def permitted_attributes
+      @permitted_attributes ||= StrongAttributes::Permissions.new
+    end
+
+    # Links presenter to permissions group of given presenter.
+    # @param [Presenter] parent_presenter
+    # @param [Array<Symbol>] relative_path
+    #   The prefix prepended before every permission check relative to parent presenter.
+    def link_permissions parent_presenter, relative_path = []
+      @permitted_attributes = StrongAttributes::Permissions.new(parent_presenter.permitted_attributes, relative_path)
+    end
+
+  end
+end
+

data/lib/strong_attributes/permissions.rb

@@ -0,0 +1,141 @@
+module StrongAttributes
+  # @private
+  #
+  #   Storage format:
+  #     Each attribute path is stored as an array of objects, usually strings in a Set. For indifferent access, 
+  #     all symbols are converted to strings.
+  #   
+  #     Arguments can also be part of permissions control. They are simply additional elements in the attribute path array,
+  #     and need not be strings or symbols. Permitting a string or symbol argument automatically permits both.
+  #
+  #     When checking if paths with tainted strings/elements are permitted, only exact matches are allowed
+  class Permissions
+
+    def prefix_path
+      @prefix_path || []
+    end
+
+    # Initialize, optionally with link to permitted paths, and the prefix to that (with copy on write semantics)
+    def initialize(permissions = nil, prefix_path = [])
+      unless permissions.nil?
+        @permitted_paths = permissions.permitted_paths
+        @prefix_path = permissions.prefix_path + canonicalize(prefix_path) # copy on write
+      end
+    end
+
+    # Checks whether everything is permitted. Considers :*, which permits all methods
+    # but not association methods to be complete.
+    # @return [Boolean]
+    def complete?
+      permitted? prefix_path + [:*]
+    end
+
+    # Permits wildcard method, but not association methods.
+    # @return self
+    def permit_all!
+      copy_on_write!
+      permitted_paths << [:*]
+      self
+    end
+
+    # Checks if the attribute path is permitted. This is the case if
+    # any array prefix has been permitted.
+    # @param [Object, Array<Object>] prefix_path
+    # @param [Object, Array<Object>] attribute_path
+    # @return [Boolean]
+    def permitted? attribute_path
+      attribute_path = canonicalize(attribute_path)
+      return true if permitted_paths.include? prefix_path + attribute_path # exact match
+      !path_tainted?(attribute_path) and permitted_by_wildcard?(prefix_path + attribute_path)  # wildcard match only if not tainted
+    end
+
+    # Selects the attribute paths which are permitted.
+    # @param [Array] prefix_path
+    #   namespace in which each of the given attribute paths are in
+    # @param [[Object, Array<Object>]*] *attribute_paths
+    #   each attribute path is a symbol or array of symbols
+    # @return [Array<Object, Array<Object>>] array of attribute paths permitted
+    def select_permitted *attribute_paths
+      attribute_paths.select { |attribute_path| permitted?(attribute_path) }
+    end
+
+    # Rejects the attribute paths which are permitted. Opposite of select_permitted.
+    # Returns the attribute paths which are not permitted.
+    #
+    # @param [Array] prefix_path
+    #   namespace in which each of the given attribute paths are in
+    # @param [[Object, Array<Object>]*] *attribute_paths
+    #   each attribute path is an object(string) or array
+    # @return [Array<Object, Array<Object>>] array of attribute paths remaining
+    def reject_permitted *attribute_paths
+      attribute_paths.reject { |attribute_path| permitted?(attribute_path) }
+    end
+
+    # Permits some attribute paths
+    #
+    # @param [Array] prefix_path
+    #   path to prepend to each attribute path
+    # @param [[Object, Array]*] *attribute_paths
+    def permit *attribute_paths
+      copy_on_write!
+      attribute_paths = attribute_paths.map{|path|canonicalize(path).taint} # exact match
+      reject_permitted(*attribute_paths).each do |attribute_path| # don't permit if already permitted
+        permitted_paths << attribute_path # prefix_path = [] because of copy on write
+      end
+      self
+    end
+
+    protected
+
+    def permitted_paths
+      @permitted_paths ||= Set.new
+    end
+
+    private
+    # Is this still referencing another objects permissions?
+    def reference?
+      !@prefix_path.nil?
+    end
+
+    # Make a copy if this still references something else, since we are planning on writing soon
+    def copy_on_write!
+      if prefix_path == []
+        @permitted_paths = permitted_paths.dup
+      elsif reference?
+        @permitted_paths, old_set = Set.new, permitted_paths
+        old_set.each do |path|
+          @permitted_paths << path[prefix_path.size...path.size] if path[0...prefix_path.size] == prefix_path
+        end
+      end
+      @prefix_path = nil
+    end
+
+    def path_tainted? attribute_path
+      attribute_path.tainted? or attribute_path.any? { |element| element.tainted? }
+    end
+
+    # Caution: Will mutate path
+    def permitted_by_wildcard? path
+      unless path.empty?
+        path[-1] = :*
+        return true if permitted_paths.include? path
+      end
+      until path.empty?
+        path[-1] = :**
+        return true if permitted_paths.include? path
+        path.pop
+      end
+      false
+    end
+
+    # Converts symbols to strings (except for wildcard symbol)
+    def canonicalize array
+      array = Array(array)
+      canonical_array = array.map{|e|e.is_a?(Symbol) ? e.to_s : e}
+      canonical_array[-1] = array.last if [:*, :**].include? array.last
+      canonical_array.taint if array.tainted?
+      canonical_array
+    end
+
+  end
+end

data/lib/strong_attributes/version.rb

@@ -0,0 +1,3 @@
+module StrongAttributes
+  VERSION = "0.0.1"
+end

data/lib/strong_attributes.rb

@@ -0,0 +1,11 @@
+require 'active_support/concern'
+#require 'active_support/core_ext/hash/keys'
+
+require "strong_attributes/version"
+require "strong_attributes/permissions"
+require "strong_attributes/permissible"
+require "strong_attributes/displayable"
+
+module StrongAttributes
+  # Your code goes here...
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+rescue LoadError
+end
+
+require 'bundler/setup'
+require 'strong_attributes'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.expect_with(:rspec) {|c| c.syntax = :expect}
+  config.order = :random
+end
+

data/spec/strong_attributes/permissible_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module StrongAttributes
+  describe Permissible do
+    it "selects permitted attributes" do
+      permissible = Object.new
+      permissible.extend(Permissible)
+      
+      permissible.permit! :a, :b, :c
+      permitted = permissible.select_permitted :a, :c, :z
+      expect(permitted).to include(:a, :c)
+      expect(permitted).to_not include(:b, :z)
+    end
+
+    it "permits all if permit_all!" do
+      permissible = Object.new
+      permissible.extend(Permissible)
+
+      permissible.permit_all!
+      permitted = permissible.select_permitted :a, :b, :c
+      expect(permitted).to include(:a, :b, :c)
+    end
+  end
+end

data/spec/strong_attributes/permissions_spec.rb

@@ -0,0 +1,202 @@
+require 'spec_helper'
+
+module StrongAttributes
+  describe Permissions do
+    describe "#complete?" do
+      it 'is initially incomplete' do
+        expect(Permissions.new.complete?).to be false
+      end
+    end
+
+    describe "#permit_all!" do
+      it 'completes the object' do
+        expect(Permissions.new.permit_all!.complete?).to be true
+      end
+    end
+
+    describe "#permit" do
+      it 'permits an attribute' do
+        expect(Permissions.new.permit(:attr).permitted?(:attr)).to be true
+      end
+
+      it 'permits with arrays of symbols' do
+        expect(Permissions.new.permit([:attr, :array]).permitted?([:attr, :array])).to be true
+      end
+
+      it 'permits multiple at once' do
+        permissions = Permissions.new.permit([:another, :array], [:attr, :array], :attr2, :attr3)
+        expect(permissions.permitted?(:attr2)).to be true
+        expect(permissions.permitted?([:attr, :array])).to be true
+      end
+
+      it 'does not mutate arguments' do
+        attrpaths = [[:attr, :path], :s]
+        Permissions.new.permit(attrpathsarg = attrpaths.dup)
+
+        expect(attrpathsarg).to eq attrpaths
+      end
+
+      it 'permits specific path after wildcard' do
+        permissions = Permissions.new.permit([:prefix, :*])
+        expect(permissions.permitted?([:prefix, "specific".taint])).to be false
+        permissions.permit([:prefix, :specific])
+        expect(permissions.permitted?([:prefix, "specific".taint])).to be true
+      end
+    end
+
+    describe "#permitted?" do
+      context 'with some attributes permitted' do
+        before(:all) do
+          @permissions = Permissions.new.permit([:another, :array], [:attr, :array], :attr2, :attr3, [:a, :wildcard, :*], [:wild, :**])
+        end
+
+        it 'permits single wildcard' do
+          expect(@permissions.permitted?([:a, :wildcard, :irrelevant])).to be true
+        end
+
+        it 'permits full wildcard' do
+          expect(@permissions.permitted?([:wild, :wildcard, :irrelevant])).to be true
+          expect(@permissions.permitted?([:wild, :irrelevant])).to be true
+        end
+
+        it 'does not permit un-prefixed path' do
+          permissions = Permissions.new(@permissions, :attr)
+          expect(permissions.permitted?(:attr2)).to be false
+          expect(permissions.permitted?([:wild, :irrelevant])).to be false
+        end
+
+        it 'permits with prefix' do
+          permissions = Permissions.new(@permissions, :attr)
+          expect(permissions.permitted?(:array)).to be true
+        end
+
+        it 'does not permit other attributes' do
+          expect(@permissions.permitted?([:attr4, :irrelevant])).to be false
+        end
+
+        it 'does not permit shortened paths' do
+          expect(@permissions.permitted?(:attr)).to be false
+        end
+
+        it 'does not mutate arguments' do
+          attrpaths = [[:attr, :path], :s, [:array, :attr2]]
+
+          @permissions.permitted?(attrpathsarg = attrpaths.dup)
+          expect(attrpathsarg).to eq attrpaths
+
+          prefix = [:prefix]
+          @permissions.permitted?(attrpathsarg = attrpaths.dup)
+          expect(attrpathsarg).to eq attrpaths
+        end
+
+        it 'is indifferent to strings' do
+          expect(@permissions.permitted?(["attr","array"])).to be true
+          expect(@permissions.permitted?("a/wildcard/irrelevant".split("/"))).to be true
+        end
+
+        it 'does not permit single wildcard if tainted' do
+          expect(@permissions.permitted?([:a, :wildcard, "irrelevant".taint])).to be false
+        end
+
+        it 'does not permit full wildcard if tainted' do
+          expect(@permissions.permitted?(["wild".taint, :wildcard, :irrelevant])).to be false
+          expect(@permissions.permitted?(["wild", "irrelevant"].taint)).to be false
+          expect(@permissions.permitted?("a/wildcard/irrelevant".taint.split("/"))).to be false
+        end
+      end
+
+      context 'with permit all' do
+        it 'all methods are true' do
+          permissions = Permissions.new.permit_all!
+          expect(permissions.permitted?(:a)).to be true
+          expect(permissions.permitted?(:b)).to be true
+        end
+
+        it 'association methods are false' do
+          permissions = Permissions.new.permit_all!
+          expect(permissions.permitted?([:a,:a])).to be false
+        end
+      end
+    end
+    describe "#select_permitted" do
+      context 'with some attributes permitted' do
+        before(:all) do
+          @permissions = Permissions.new.permit([:another, :array], [:attr, :array, :*], :attr2, :attr3)
+          @permissions.permit([], [:attr, :arrays], :attr2, :attr3)
+        end
+
+        it 'can select something which is permitted' do
+          expect(@permissions.select_permitted(:attr2)).to eq [:attr2]
+          expect(@permissions.select_permitted([:attr, :array, :irrelevant])).to eq [[:attr, :array, :irrelevant]]
+          expect(@permissions.select_permitted([:another, :array])).to eq [[:another, :array]]
+        end
+
+        it 'does not select wildcard path without wildcard' do
+          expect(@permissions.select_permitted([:attr, :array])).to be_empty
+        end
+
+        it 'can select multiple permitted attributes' do
+          attribute_paths = [[:attr2], :attr3, [:another, :array], [:attr, :array, :method]]
+          permitted = @permissions.select_permitted(*attribute_paths)
+          attribute_paths.each do |attribute_path|
+            expect(permitted).to include attribute_path
+          end
+        end
+
+        it 'selects only permitted attributes in the original order' do
+          permitted_paths = [:attr2, :attr3, [:attr, :arrays], [:attr, :array, :meth], [:attr3]]
+          unpermitted_paths = [:attr4, :attr5, [:attrk, :irrelevant], [:attr, :ar], [:attr, :arrays, :more]]
+          attribute_paths = (unpermitted_paths + permitted_paths).shuffle
+          expect(@permissions.select_permitted(*attribute_paths)).to eq((attribute_paths & permitted_paths))
+        end
+
+        it 'does not mutate arguments' do
+          attrpaths = [[:attr, :path], :s, [:array, :attr2]]
+
+          @permissions.select_permitted(attrpathsarg = attrpaths.dup)
+          expect(attrpathsarg).to eq attrpaths
+
+          attrpaths = [[:attr, :array, :meth], :s, [:array, :attr2]]
+          @permissions.select_permitted(attrpathsarg = attrpaths.dup)
+          expect(attrpathsarg).to eq attrpaths
+        end
+      end
+
+      context 'with permit all' do
+        it 'everything is selected' do
+          permissions = Permissions.new.permit_all!
+          attribute_paths = [:attr2, :attr3, :attr2, :attr, :array]
+          permitted = permissions.select_permitted([:prefix, :array], *attribute_paths)
+          expect(permitted).to eq(attribute_paths)
+        end
+      end
+    end
+    describe "#reject_permitted" do
+      context 'with some attributes permitted' do
+        before(:all) do
+          @permissions = Permissions.new.permit([:another, :array], [:attr, :array, :*], :attr2, :attr3)
+          @permissions.permit([], [:attr, :arrays], :attr2, :attr3)
+        end
+
+        it 'selects only unpermitted attributes in the original order' do
+          permitted_paths = [:attr2, :attr3, [:attr, :arrays], [:attr, :array, :meth], [:attr3]]
+          unpermitted_paths = [:attr4, :attr5, [:attrk, :irrelevant], [:attr, :ar], [:attr, :arrays, :more]]
+          attribute_paths = (unpermitted_paths + permitted_paths).shuffle
+          expect(@permissions.reject_permitted(*attribute_paths)).to eq((attribute_paths & unpermitted_paths))
+        end
+
+        it 'does not mutate arguments' do
+          attrpaths = [[:attr, :path], :s, [:array, :attr2]]
+
+          @permissions.reject_permitted(attrpathsarg = attrpaths.dup)
+          expect(attrpathsarg).to eq attrpaths
+
+          attrpaths = [[:attr, :array, :meth], :s, [:array, :attr2]]
+          @permissions.reject_permitted(attrpathsarg = attrpaths.dup)
+          expect(attrpathsarg).to eq attrpaths
+        end
+      end
+    end
+  end
+end
+

data/spec/strong_attributes/simplecov_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+SimpleCov.command_name 'spec:strong_presenter' if defined? SimpleCov
+

data/strong_attributes.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'strong_attributes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "strong_attributes"
+  gem.version       = StrongAttributes::VERSION
+  gem.authors       = ["Ronald Chan"]
+  gem.email         = ["ronalchn@gmail.com"]
+  gem.description   = %q{strong_attributes provides a strong_parameters-style permit interface using a wrapper around your model. By accessing model attributes in your views only through this interface, you ensure that any attributes displayed are explicitly permitted, and sensitive data is not displayed to unauthorized users. This keeps your views free of authorization logic.}
+  gem.summary       = %q{strong_attributes provides a strong_parameters-style permit interface using a wrapper around your model. By accessing model attributes in your views only through this interface, you ensure that any attributes displayed are explicitly permitted, and sensitive data is not displayed to unauthorized users. This keeps your views free of authorization logic.}
+  gem.homepage      = "https://github.com/ronalchn/strong_attributes"
+  gem.license       = "MPLv2"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|gem|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport', '>= 3.0'
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency 'rake', '>= 0.9.2'
+  gem.add_development_dependency 'rspec', '~> 2.12'
+  gem.add_development_dependency 'rspec-mocks', '>= 2.12.1'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: strong_attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ronald Chan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+description: strong_attributes provides a strong_parameters-style permit interface
+  using a wrapper around your model. By accessing model attributes in your views only
+  through this interface, you ensure that any attributes displayed are explicitly
+  permitted, and sensitive data is not displayed to unauthorized users. This keeps
+  your views free of authorization logic.
+email:
+- ronalchn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/strong_attributes.rb
+- lib/strong_attributes/displayable.rb
+- lib/strong_attributes/permissible.rb
+- lib/strong_attributes/permissions.rb
+- lib/strong_attributes/version.rb
+- spec/spec_helper.rb
+- spec/strong_attributes/permissible_spec.rb
+- spec/strong_attributes/permissions_spec.rb
+- spec/strong_attributes/simplecov_spec.rb
+- strong_attributes.gemspec
+homepage: https://github.com/ronalchn/strong_attributes
+licenses:
+- MPLv2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: strong_attributes provides a strong_parameters-style permit interface using
+  a wrapper around your model. By accessing model attributes in your views only through
+  this interface, you ensure that any attributes displayed are explicitly permitted,
+  and sensitive data is not displayed to unauthorized users. This keeps your views
+  free of authorization logic.
+test_files: []