as_json_presentable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 007b24299611eae692e4e5e14181cb7459162576
+  data.tar.gz: 5b1c8f3a28dcaa5ee785c35135ad4a7e51c5eb7e
+SHA512:
+  metadata.gz: d78c0343bc8eb1371e921c52033064ff05abc36066d65f1ac739a3a97ecf2539bee37b08fcecb30e41592b72d97f5624b7313e92e662c2e42af140b1c8ba631b
+  data.tar.gz: fffe8e476ceadbac816c21db32f0979ba69aa31317865aa164addbc00cf52c285dc3317817c9343516b32d816cdc2c8897762fcb5892fa98bf091d35f33c0887

data/lib/as_json_presentable.rb

@@ -0,0 +1,55 @@
+require 'as_json_presentable/presenter'
+
+module AsJsonPresentable
+
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  # Attempts to delegate to the presenter class's `#as_json`
+  # if it exists, and falls back to the parent class's
+  # implementation if it does not.
+  def as_json(options=nil)
+    if options && options[:presenter_action] && json_presenter_class
+      json_presenter_class.new(self).as_json(options)
+    else
+      super(options)
+    end
+  end
+
+  # Returns the presenter class, or nil if
+  # no presenter class exists
+  def json_presenter_class
+    self.class.json_presenter_class
+  end
+
+  module ClassMethods
+
+    # Allows the user to explicitly set the presenter class
+    # if the default naming convention isn't desired.
+    def define_json_presenter_class(klass)
+      @json_presenter_class = klass
+    end
+
+    # Returns the presenter class if it has been explicitly
+    # set or can be implied through naming conventions, or
+    # returns nil if no presenter class exists.
+    #
+    # By default, the presenter class is inferred to be
+    # named after the model class, but with the suffix
+    # of "Presenter".
+    #
+    # e.g. If you have a model class called `Foo`,
+    # its presenter is assumed to be called `FooPresenter`
+    #
+    # Alternatively, the presenter class can be explicitly
+    # defined with `::defined_json_presenter_class`
+    def json_presenter_class
+      return @json_presenter_class if defined?(@json_presenter_class)
+
+      klass_name = "#{self.name}Presenter"
+      @json_presenter_class = Module.const_get(klass_name) if Module.const_defined?(klass_name)
+    end
+  end
+
+end

data/lib/as_json_presentable/presenter.rb

@@ -0,0 +1,45 @@
+module AsJsonPresentable
+  # Base JSON presenter class
+  class Presenter
+    attr_reader :resource
+
+    def initialize(resource)
+      @resource = resource
+    end
+
+    # Looks for the option `:presenter_action`. If it exists,
+    # looks for a method called `#as_<presenter_action>_json`
+    # and delegates to that method.
+    # If `:presenter_action` isn't in the options, or it
+    # references a method that the presenter doesn't respond to,
+    # falls back to the resource's `#as_json` implementation.
+    #
+    # e.g.
+    #
+    # `presenter.as_json(presenter_action: :index)`
+    #
+    # will delegate to
+    #
+    # `presenter.as_index_json`
+    def as_json(options=nil)
+      presenter_action = (options || {}).delete(:presenter_action)
+
+      if has_presenter_method?(presenter_action)
+        send(presenter_method(presenter_action), options)
+      else
+        resource.as_json(options)
+      end
+    end
+
+  private
+
+    def has_presenter_method?(presenter_action)
+      respond_to?(presenter_method(presenter_action))
+    end
+
+    def presenter_method(presenter_action)
+      "as_#{presenter_action}_json"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: as_json_presentable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason Rush
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: This is a simple implementation of the presenter pattern for JSON presentation.
+email: jason@pandastrike.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/as_json_presentable.rb
+- lib/as_json_presentable/presenter.rb
+homepage: http://pandastrike.com/
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: JSON presenter
+test_files: []
+has_rdoc: