vizier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ae1adcb210a11987c89af85c6056d14f61ac9b7
+  data.tar.gz: a6ee77ad5cabd5e9c3cecea6aca48eb0e640e3b9
+SHA512:
+  metadata.gz: db066fec049d40e28ad4bf0e60231175220e7855df95f3e7998b019e62bc27ec8cf225d72fa1268d0d855331ede97cb856378bb25bebeb79deefa6bad351e300
+  data.tar.gz: e4139ee987a2a38ec94baea80a9683bd2d8a7911af9847c97badcf6f967dd93c180bcebe3bb4ec25fefcd326390ad798968265eb0a2b933855df93e16ec3d256

data/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,30 @@
+Rails:
+  Enabled: true
+
+Rails/Delegate:
+  Enabled: false
+
+# inherit_gem:
+#   rubocop-rails:
+#     - config/rails.yml
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: same_line
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+  ExcludedMethods: ['describe', 'context']
+
+Style/StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in vizier.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,27 @@
+Copyright (c) 2018, The Regents of the University of Michigan.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+* Neither the name of the The University of Michigan nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS OF THE UNIVERSITY OF MICHIGAN AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OF THE
+UNIVERSITY OF MICHIGAN BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO,PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,25 @@
+[![Build Status](https://travis-ci.org/mlibrary/vizier.svg?branch=master)](https://travis-ci.org/mlibrary/vizier?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/mlibrary/vizier/badge.svg?branch=master)](https://coveralls.io/github/mlibrary/vizier?branch=master)
+
+# Vizier
+
+Vizier helps you present information appropriately.
+
+It is a small library for writing and using policy-aware presenters, especially
+in Rails applications, conveniently.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vizier'
+```
+
+And then execute:
+
+    $ bundle
+
+## License
+
+Vizier is licensed under the BSD-3-Clause license. See [LICENSE.md](LICENSE.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vizier"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vizier.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'vizier/version'
+
+# Top level module for Vizier
+module Vizier
+  # Just the constant for now
+end
+
+require 'vizier/null_presenter'
+require 'vizier/read_only_policy'
+
+require 'vizier/presenter_config'
+require 'vizier/caching_presenter_config'
+require 'vizier/default_presenter_config'
+
+require 'vizier/collection_presenter'
+require 'vizier/resource_presenter'
+require 'vizier/presenter_factory'

data/lib/vizier/caching_presenter_config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Vizier
+  # A presenter configuration that caches the type lookup
+  #
+  # For development use reloading is convenient, but in production
+  # the constants should not be redefined. We cache them here to
+  # avoid repeated global lookups.
+  class CachingPresenterConfig < PresenterConfig
+    def type
+      @type ||= super
+    end
+
+    def presenter
+      @presenter ||= super
+    end
+
+    def policy
+      @policy ||= super
+    end
+  end
+end

data/lib/vizier/collection_presenter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Vizier
+  # Base implementation for a Collection Presenter.
+  #
+  # This class can be extended in your application to inherit the convenience
+  # of delegating to a collection policy's resolved scope and having a default
+  # `present` method available for wrapping other objects according to the
+  # configured factory.  To specify a factory, override `presenter_factory`.
+  class CollectionPresenter
+    include Enumerable
+
+    def initialize(policy, view, presenter_factory: PresenterFactory.new)
+      @policy = policy
+      @view   = view
+      @presenter_factory = presenter_factory
+    end
+
+    def each
+      resources.each { |resource| yield resource }
+    end
+
+    def empty?
+      resources.empty?
+    end
+
+    protected
+
+    def resources
+      @resources ||= policy.resolve.map do |resource|
+        present(resource)
+      end
+    end
+
+    def present(resource)
+      presenter_factory[resource, policy.user, view]
+    end
+
+    attr_reader :policy, :view, :presenter_factory
+  end
+end

data/lib/vizier/default_presenter_config.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Vizier
+  # A base implementation of a default presenter configuration, used by
+  # by PresenterFactory to provide a fall-through for unmapped types.
+  #
+  # This uses `NullPresenter` and `ReadOnlyPolicy` to have generic, fully
+  # delegating presenters with a `show?` permission passing unconditionally.
+  class DefaultPresenterConfig
+    attr_reader :config_type
+
+    def initialize(config_type)
+      @config_type = config_type
+    end
+
+    def for(type)
+      config_type.new(type, NullPresenter, ReadOnlyPolicy)
+    end
+  end
+end

data/lib/vizier/null_presenter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Vizier
+  # Simple pass-through presenter that serves as a default.
+  #
+  # We may want to use something other than `.new` so this
+  # can actually return the object rather than a new instance
+  # of itself.
+  class NullPresenter < SimpleDelegator
+    def initialize(object, *)
+      __setobj__ object
+    end
+  end
+end

data/lib/vizier/presenter_config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Vizier
+  # Mapping for a given type to presenter and policy types.
+  #
+  # This configuration does not cache the constant lookups, so it supports
+  # reloading of the types in development.  The CachingPresenterConfig should
+  # be used in production.
+  class PresenterConfig
+    def initialize(type, presenter, policy)
+      @type_name      = type.to_s
+      @presenter_name = presenter.to_s
+      @policy_name    = policy.to_s
+    end
+
+    def present(object, user, view)
+      presenter.new(policy.new(user, object), view)
+    end
+
+    def type
+      Object.const_get(@type_name)
+    end
+
+    def presenter
+      Object.const_get(@presenter_name)
+    end
+
+    def policy
+      Object.const_get(@policy_name)
+    end
+  end
+end

data/lib/vizier/presenter_factory.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Vizier
+  # Factory for locating and creating a presenter based on an object's type.
+  class PresenterFactory
+    # Construct a factory with a mapping of types to their default presenters
+    # and policies.
+    #
+    # @param presenter_map [Hash] the mapping of classes of strings to a pair,
+    #   where the first item is the default presenter type, and the second is the
+    #   default policy type.
+    def initialize(
+        presenter_map = {},
+        config_type: PresenterConfig,
+        default_config: DefaultPresenterConfig.new(config_type))
+
+      @config_type    = config_type
+      @default_config = default_config
+
+      @configs = Hash.new do |_configs, type|
+        default_config.for(type)
+      end
+
+      presenter_map.each do |type, config|
+        @configs[type.to_s] = config_type.new(type, config.first, config.last)
+      end
+    end
+
+    def [](object, user, view)
+      configs[object.class.to_s].present(object, user, view)
+    end
+
+    private
+
+    attr_accessor :configs, :config_type, :default_config
+  end
+end

data/lib/vizier/read_only_policy.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Vizier
+  # This is a basic/dummy policy that can be used as a default.
+  # There is no hard dependency on Checkpoint, but it has the same
+  # interface as a minimal resource policy.
+  class ReadOnlyPolicy
+    attr_reader :user, :resource
+
+    def initialize(user, resource)
+      @user     = user
+      @resource = resource
+    end
+
+    def show?
+      true
+    end
+
+    def authorize!(action, message = nil)
+      raise NotAuthorizedError, message unless send(action)
+    end
+  end
+end

data/lib/vizier/resource_presenter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Vizier
+  # Base implementation for a Resource Presenter.
+  #
+  # This class can be extended in your application to inherit the convenience
+  # of delegating to a policy's resource and having a default `present` method
+  # available for wrapping other objects according to the configured factory.
+  # To specify a factory, override `presenter_factory`.
+  class ResourcePresenter < SimpleDelegator
+    extend Forwardable
+
+    def initialize(policy, view, presenter_factory: PresenterFactory.new)
+      @policy = policy
+      @view   = view
+      @presenter_factory = presenter_factory
+      __setobj__ policy.resource
+    end
+
+    protected
+
+    def resource
+      policy.resource
+    end
+
+    def present(object)
+      presenter_factory[object, policy.user, view]
+    end
+
+    attr_reader :policy, :view, :presenter_factory
+  end
+end

data/lib/vizier/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vizier
+  VERSION = "0.1.0"
+end

data/vizier.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vizier/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "vizier"
+  spec.version = Vizier::VERSION
+  spec.authors = ["Noah Botimer"]
+  spec.email   = ["botimer@umich.edu"]
+  spec.license = "BSD-3-Clause"
+
+  spec.summary = <<~SUMMARY
+    Vizier supports building policy-aware presenters for the view layer of applications,
+    especially those using Rails.
+  SUMMARY
+
+  spec.description = <<~DESCRIPTION
+    Vizier helps you present the right information to your users. By using policies and configurable
+    defaults, it becomes easier to build presenters and be sure that model objects are wrapped in
+    presenters when they are delivered to view templates.
+  DESCRIPTION
+
+  spec.homepage = "https://github.com/mlibrary/vizier"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.52"
+  spec.add_development_dependency "rubocop-rails", "~> 1.1"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.16"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: vizier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Noah Botimer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: |
+  Vizier helps you present the right information to your users. By using policies and configurable
+  defaults, it becomes easier to build presenters and be sure that model objects are wrapped in
+  presenters when they are delivered to view templates.
+email:
+- botimer@umich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/vizier.rb
+- lib/vizier/caching_presenter_config.rb
+- lib/vizier/collection_presenter.rb
+- lib/vizier/default_presenter_config.rb
+- lib/vizier/null_presenter.rb
+- lib/vizier/presenter_config.rb
+- lib/vizier/presenter_factory.rb
+- lib/vizier/read_only_policy.rb
+- lib/vizier/resource_presenter.rb
+- lib/vizier/version.rb
+- vizier.gemspec
+homepage: https://github.com/mlibrary/vizier
+licenses:
+- BSD-3-Clause
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Vizier supports building policy-aware presenters for the view layer of applications,
+  especially those using Rails.
+test_files: []