simple_representer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43c5d72e991bc2429713d2e1c6f45ca3cfdc0ccc38649e761d40c4f569a8e5ef
+  data.tar.gz: 7aaf16de7f25dd8078da3dcbf55ea9f82057081ca2bc32c31ccd7fd419a59e22
+SHA512:
+  metadata.gz: ce011f9f391a5f471fd2c74e6012312e28fd3a4a3f5add071444990c59dcbab68cb7fb9b1491f2f29f559eb011714b1d57d47fdc0543a9400be5ce88baf12412
+  data.tar.gz: 75b4bbb3eaca37409d4f6d26d1c5c4ab68cede90a2cb8b7136bcf1aea3fcf3133e7150f364a19160e95ac99cce0e1d7e15d263ce4731306f5aaed86e8f9270f7

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run RSpec
+      run: bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    simple_representer (1.0.0)
+      oj (~> 3.10.16)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    oj (3.10.18)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.10.0)
+  simple_representer!
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Paladin Software
+
+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,112 @@
+# SimpleRepresenter
+Simple solution to represent your objects as hash or json.
+
+## Instalation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_representer'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+Create a class that inherits from `SimpleRepresenter::Representer`
+and define your representation using `property` (to access methods defined in represented object)
+and `computed` (to use methods defined inside representer) class methods.
+
+```ruby
+class UserRepresenter < SimpleRepresenter::Representer
+    property :id
+    computed :full_name
+    computed :is_active
+
+    def full_name
+      "#{represented.first_name} #{represented.last_name}"
+    end
+
+    def is_active
+      !represented.activated_at.nil?
+    end
+end
+```
+Pass your object as argument in initializer and call `to_h`/`to_hash` or `to_json`.
+You can also represent hashes like normal objects (see: [SimpleRepresenter::CallableHash](./lib/simple_representer/callable_hash.rb))
+```ruby
+user = User.find(1)
+UserRepresenter.new(user).to_json
+ => "{\"id\":1,\"full_name\":\"Jon Doe\",\"is_active\":false}"
+UserRepresenter.new(user).to_hash
+ => {:id=>1, :full_name=>"Jon Doe", :is_active=>false}
+```
+
+### Collections
+To use SimpleRepresenter with collection of objects use `for_collection` method:
+```ruby
+ UserRepresenter.for_collection(users).to_json
+ => "[{\"id\":1,\"full_name\":\"Jon Doe\",\"is_active\":false},{\"id\":2,\"full_name\":\"Jon Wick\",\"is_active\":true}]"
+```
+
+### Options
+Both `property` and `computed` have following options:
+- `if` to make execution dependent on condition:
+```ruby
+property :full_name, if: -> { first_name && last_name }
+```
+- `as` to rename field in representation:
+```ruby
+property :is_active?, as: :is_active
+```
+- `default` to set default value:
+```ruby
+property :name, default: 'Paladin'
+```
+- `render_nil` to render or skip nil value (default is false):
+```ruby
+# will render { name: nil } if name is nil
+property :name, render_nil: true
+```
+- `representer` to use different representer for nested objects.
+If it's an array `for_collection` will be automatically called.
+```ruby
+property :comments, representer: CommentsRepresenter
+```
+
+### Additional arguments
+You can pass additional arguments to initializer. You can access them inside computed methods or any other place using `options`:
+```ruby
+class UserRepresenter < SimpleRepresenter::Representer
+    property :id
+    property :full_name, if: -> { options[:display_name] }
+end
+```
+```ruby
+user = OpenStruct.new({ id: 5, full_name: 'Batman' })
+UserRepresenter.new(user, display_name: false).to_json
+ => "{\"id\":5}"
+```
+You can set default options for properties by using `defaults`:
+```ruby
+class UserRepresenter < SimpleRepresenter::Representer
+    defaults render_nil: true # render nil properties
+    property :id
+end
+```
+## Migrating from Roar
+Replace all occurrences of `exec_context: :decorator` to `computed`:
+```ruby
+property :full_name, exec_context: :decorator
+=>
+computed :full_name
+```
+Replace `decorator` with `representer` and `collection` with `computed` or `property` for nested objects:
+```ruby
+collection :songs, decorator: SongRepresenter
+=>
+property :songs, representer: SongRepresenter
+```
+
+## Specs
+Just run `rspec`.

data/lib/simple_representer/callable_hash.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SimpleRepresenter
+  module CallableHash
+    private
+
+    def method_missing(symbol, *args)
+      return self[symbol] if include?(symbol)
+      return self[symbol.to_s] if include?(symbol.to_s)
+
+      super
+    end
+
+    def respond_to_missing?(symbol, include_private = false)
+      include?(symbol) || include?(symbol.to_s) || super
+    end
+  end
+end

data/lib/simple_representer/collection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+module SimpleRepresenter
+  class Collection
+    attr_reader :representer, :collection, :options
+
+    def initialize(representer, collection = [], options = {})
+      @representer = representer
+      @collection = collection
+      @options = options
+    end
+
+    def to_h
+      collection.map { |elem| representer.new(elem, **options).to_h }
+    end
+    alias to_hash to_h
+
+    def to_json(*_args)
+      ::Oj.generate(to_h)
+    end
+  end
+end

data/lib/simple_representer/computed.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'field'
+
+module SimpleRepresenter
+  class Computed < Field
+    def process(representer)
+      representer.public_send(field)
+    end
+  end
+end

data/lib/simple_representer/definable.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'property'
+require_relative 'computed'
+
+module SimpleRepresenter
+  module Definable
+    def self.included(host_class)
+      host_class.extend ClassMethods
+    end
+
+    module ClassMethods
+      def property(field, **options)
+        definitions << Property.new(field, default_options.merge(options))
+      end
+
+      def computed(field, **options)
+        definitions << Computed.new(field, default_options.merge(options))
+      end
+
+      def defaults(**options)
+        default_options.merge!(options)
+      end
+
+      def definitions
+        @definitions ||= []
+      end
+
+      def default_options
+        @default_options ||= {}
+      end
+
+      def inherited(subclass)
+        super
+        subclass.instance_variable_set('@definitions', instance_variable_get('@definitions').clone)
+        subclass.instance_variable_set('@default_options', instance_variable_get('@default_options').clone)
+      end
+    end
+  end
+end

data/lib/simple_representer/field.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SimpleRepresenter
+  class Field
+    attr_reader :field, :options
+
+    def initialize(field, options)
+      @field = field.to_sym
+      @options = options
+    end
+
+    def call(representer)
+      return if options[:if] && !representer.instance_exec(&options[:if])
+
+      value = process(representer)
+      value = options[:default] if value.nil?
+      value = nested_representer(value) if options[:representer] && !value.nil?
+
+      build_field(value)
+    end
+
+    private
+
+    def nested_representer(value)
+      return options[:representer].for_collection(value).to_h if value.is_a?(Array)
+
+      options[:representer].new(value).to_h
+    end
+
+    def build_field(value)
+      return if value.nil? && !options.fetch(:render_nil, false)
+
+      [(options[:as] || field).to_sym, value]
+    end
+  end
+end

data/lib/simple_representer/property.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'field'
+
+module SimpleRepresenter
+  class Property < Field
+    def process(representer)
+      return nil unless representer.represented.respond_to?(field)
+
+      representer.represented.public_send(field)
+    end
+  end
+end

data/lib/simple_representer/representer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+require_relative 'callable_hash'
+require_relative 'definable'
+require_relative 'collection'
+
+module SimpleRepresenter
+  class Representer
+    include Definable
+
+    attr_reader :represented, :options
+
+    def initialize(represented, **options)
+      @represented = represented.is_a?(Hash) ? represented.clone.extend(CallableHash) : represented
+      @options = options
+    end
+
+    # return hash with symbols as keys
+    def to_h
+      build_result do |obj, result|
+        obj[result[0]] = result[1]
+      end
+    end
+    alias to_hash to_h
+
+    def to_json(*_args)
+      ::Oj.generate(to_h)
+    end
+
+    def self.for_collection(collection, **options)
+      Collection.new(self, collection, options)
+    end
+
+    private
+
+    def build_result
+      self.class.definitions.each_with_object({}) do |definition, obj|
+        result = definition.call(self)
+        next unless result
+
+        yield obj, result
+      end
+    end
+  end
+end

data/lib/simple_representer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleRepresenter
+  VERSION = '1.0.0'
+end

data/lib/simple_representer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'simple_representer/representer'
+
+module SimpleRepresenter
+end

data/simple_representer.gemspec

@@ -0,0 +1,19 @@
+require_relative 'lib/simple_representer/version'
+
+Gem::Specification.new do |s|
+  s.name = 'simple_representer'
+  s.version = SimpleRepresenter::VERSION
+  s.summary = 'Simple solution to represent your objects as hash or json.'
+  s.authors = ['Karol Bąk']
+  s.license = 'MIT'
+  s.homepage = 'https://github.com/paladinsoftware/simple_representer'
+
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'oj', '~> 3.10.16'
+
+  s.add_development_dependency 'rspec', '~> 3.10.0'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: simple_representer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Karol Bąk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.16
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/simple_representer.rb
+- lib/simple_representer/callable_hash.rb
+- lib/simple_representer/collection.rb
+- lib/simple_representer/computed.rb
+- lib/simple_representer/definable.rb
+- lib/simple_representer/field.rb
+- lib/simple_representer/property.rb
+- lib/simple_representer/representer.rb
+- lib/simple_representer/version.rb
+- simple_representer.gemspec
+homepage: https://github.com/paladinsoftware/simple_representer
+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.1.4
+signing_key:
+specification_version: 4
+summary: Simple solution to represent your objects as hash or json.
+test_files: []