hc-presenter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44fa3d12848ef04a66f2a3393a5641f4d5a97e753ca89edf3cdaa67925336a93
+  data.tar.gz: '0872b4725677dc311b8dae5111702701313bd2f2acd76d3cce1be81fed732167'
+SHA512:
+  metadata.gz: a151ba2e00ef1334c4aa10d00696e5495f78ebc39acb85e9aa1e9c12f8b01a4a2881847718dcd18773a5612e3549bec79147ee3f6ef6c892daf72188296656b9
+  data.tar.gz: d841741b698b9913d04d166cc6c80896324bcae50b16fa366ab31c804aa3d193c4b15709b1392a56c16bc724d47c7fdfea215244f653b9bf9d71bba6cb2f570b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hc-permalink.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Hockey Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# HC::Presenter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hc/presenter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hc-presenter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hc-presenter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hc-presenter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hc/presenter"
+
+# 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/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/hc-presenter.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hc/presenter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hc-presenter"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Jack Hayter"]
+  spec.email         = ["jack@hockey-community.com"]
+
+  spec.summary       = "A super simple object serializer"
+  spec.description   = "Transforms objects and collections into hashes for rendering as JSON"
+  spec.homepage      = "https://github.com/HockeyCommunity/presenter"
+  spec.license       = "MIT"
+
+  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"
+end

data/lib/hc/presenter/base.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+module HC
+  module Presenter
+
+    # Creates a platform for other presenters to serialize objects into hashes
+    #
+    class Base
+
+      # Initialization of required and optional instance variables
+      #
+      def initialize(object:, controller_context: nil, options: {})
+        @object = object
+        @options = options.try(:to_h).to_h.symbolize_keys
+        @controller_context = controller_context
+      end
+
+      # Abstraction method for nicer top-level access to object context with a
+      # friendly name, plus allow access to any options that were passed in.
+      #
+      def self.presents(name)
+        define_method(name) do
+          @object
+        end
+        define_method(:options) do
+          @options
+        end
+        define_method(:controller_context) do
+          @controller_context
+        end
+      end
+
+      def present(object, options: nil, method: nil)
+        if @controller_context
+          @controller_context.present(object, options: options || @options, method: method)
+        else
+          HC::Presenter.present(object, method: method, options: options)
+        end
+      end
+
+      private
+
+      # This method passes off missing methods to the controller context,
+      # thus allowing us access to that controller's methods in the presenters.
+      # This should be used with care, and should only really be used for
+      # authorization control and permissions-based conditional content.
+      #
+      def method_missing(*args, &block)
+        return nil unless @controller_context
+        @controller_context.send(*args, &block)
+      end
+
+    end
+
+  end
+end

data/lib/hc/presenter/helper_methods.rb

@@ -0,0 +1,11 @@
+module HC
+  module Presenter
+    module HelperMethods
+
+      def present(object, klass: nil, method: nil, options: {})
+        HC::Presenter.present(object, klass: klass, controller_context: self, method: method, options: options)
+      end
+
+    end
+  end
+end

data/lib/hc/presenter/version.rb

@@ -0,0 +1,5 @@
+module HC
+  module Presenter
+    VERSION = "0.1.0"
+  end
+end

data/lib/hc/presenter.rb

@@ -0,0 +1,28 @@
+require "hc/presenter/base"
+require "hc/presenter/helper_methods"
+require "hc/presenter/version"
+
+module HC
+  module Presenter
+
+    def self.present(object, klass: nil, controller_context: nil, method: nil, options: {})
+      if object.nil?
+        return object
+      elsif object.is_a?(DateTime) || object.is_a?(Time)
+        return object.to_formatted_s(:iso8601)
+      elsif object.respond_to?(:count)
+        content = object.collect{ |o| present(o, klass: klass, controller_context: controller_context, method: method, options: options) }
+        return content
+      else
+        klass ||= "#{object.class}Presenter".constantize
+        presenter_object = klass.new(object: object, controller_context: controller_context, options: options)
+        if !method.nil? && presenter_object.respond_to?(method)
+          presenter_object.send(method)
+        else
+          presenter_object.send(:format)
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: hc-presenter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Hayter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Transforms objects and collections into hashes for rendering as JSON
+email:
+- jack@hockey-community.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hc-presenter.gemspec
+- lib/hc/presenter.rb
+- lib/hc/presenter/base.rb
+- lib/hc/presenter/helper_methods.rb
+- lib/hc/presenter/version.rb
+homepage: https://github.com/HockeyCommunity/presenter
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A super simple object serializer
+test_files: []