view_composer 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c23d5629b4776fc2cb676d9f8932f48f960b5d1
+  data.tar.gz: 6dd23939c1f09978e3dbfdb1286f1cd7a9ec2bf3
+SHA512:
+  metadata.gz: 749e79cc3046d4f7aaccd6b252832a4218190cd76cc2273604d6ad7c52c8708c8525ba9d52c1ff04f72da8c34a98a73fcdb5d51fc12d494abd3f4d659398e323
+  data.tar.gz: 5a0fd538b83a520602f0bfd892bae48535caac04ed73b932edecc20173653ad998bfc3fd66dc5e79f73c0b9ec34bdb5ea0429df2e94d9ae8a8dcd597d6335477

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format progress 
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at korytegman@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kory Tegman
+
+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,76 @@
+# ViewComposer
+
+View Composer makes it easy to compose view objects for ruby apps. Create new composers, pass them a model and classes to merge, and all instance methods of the classes will be available on the composer. The Composer will also serialize these instance methods into `json` for an api. I like to think of it as a mix between Draper and Active Model Serializer but built on ideas of composition from Sandi Metz.
+
+This is still pre 1.0 software and the api will change.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'view_composer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install view_composer
+
+## Usage
+
+create a new composer that inherits from `BaseComposer`. and use the attributes api (similar to active model serializer) to let your composer know what methods to respond to.
+
+``` ruby
+class PostComposer < BaseComposer
+    attributes :id, :name, :body
+end
+
+post_composer = PostCompser.new(model: Post.new(name: "a post") )
+post_composer.name #=> "a post"
+post_composer.id #=> 1
+post_composer.hash_attrs #=> {id: 1, name: "a post", body: nil}
+post_composer.to_json #=> "{\"id\":\"1\",\"name\":\"a post\", \"body\": \"\"}"
+```
+
+if you would like to override the model's value you can define it as a method
+
+``` ruby
+class PostComposer < BaseComposer
+    attributes :id, :name, :body
+    
+    def name
+        "special super #{@model.name}"
+    end
+end
+post_composer.name #=> special super a post
+```
+
+the last part of this (that really makes it a composer) is that you can pass other classes to the composer and it will define those methods on the composer and serialize them into the same json object as well. Say you have `AdminStats` for your post that takes an instance of a post and responds to `total_reads` and `referrers`. ie: `AdminStats.new(post).total_reads` returns `1000`.
+
+your composer would look like this: 
+``` ruby
+post_composer = PostComposer.new(model: post, composable_objects: [AdminStats])
+post_composer.total_reads #=> 1000
+post_composer.referrers #=> ["bily", "bob", "jane"]
+post_composer.to_json #=> {"id": "1", "name": "a post", "body": "", "total_reads": "1000", "referrers": ["bily", "bob", "jane"] }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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]/ViewComposer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+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 "view_composer"
+
+# 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

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/view_composer/base_composer.rb

@@ -0,0 +1,136 @@
+require 'json'
+EXCLUDED_METHODS = [:to_json, :hash_attrs,
+                    :set_inherited_methods_list,
+                    :instance_methods,
+                    :inherited_methods,
+                    :attributes,
+                    :instance_attributes,
+                    :set_model_methods,
+                    :super_model_methods]
+class BaseComposer
+  class << self
+    attr_accessor :_attributes,
+                  :_instance_attrs,
+                  :_model_methods,
+                  :_instance_defined_methods,
+                  :_inherited_methods
+  end
+  self._attributes = []
+  self._instance_attrs = []
+  self._inherited_methods = []
+  self._model_methods = []
+
+  def initialize(model:, composable_objects: [] )
+    set_inherited_methods_list
+    @model = model
+    @json_hash = {}
+    set_model_methods
+    set_instance_defined_methods
+    set_attributes_methods
+    setup_comp_objs(composable_objects)
+    methods_to_hash
+  end
+
+  def self.attributes(*attrs)
+    self._instance_attrs = attrs
+    Array(attrs).each {|attr| self._attributes << attr}
+  end
+
+  def self.inherited(base)
+    super
+    base._attributes = self._attributes.dup
+    base._inherited_methods = self._inherited_methods.dup
+    base._model_methods = self._model_methods.dup
+  end
+
+  def hash_attrs
+    @json_hash
+  end
+
+  def to_json
+    @json_hash.to_json
+  end
+
+private
+
+  def set_model_methods
+    new_model_methods = attributes - instance_methods
+    new_model_methods = new_model_methods - inherited_methods
+    new_model_methods = new_model_methods + super_model_methods
+
+    if self.class.superclass != Object
+      self.class._model_methods = super_model_methods + new_model_methods
+    else
+      self.class._model_methods = new_model_methods
+    end
+  end
+
+  def set_instance_defined_methods
+    if self.class._instance_defined_methods != nil
+      self.class._instance_defined_methods += self.class._model_methods
+    else
+      self.class._instance_defined_methods = self.class._model_methods
+    end
+  end
+
+  def instance_attributes
+    @instance_attributes ||= self.class._instance_attrs || []
+  end
+
+  def super_model_methods
+    return [] if self.class.superclass === Object
+    @super_model ||= self.class.superclass._model_methods || []
+  end
+
+  def attributes
+    @attributes ||= self.class._attributes
+  end
+
+  def instance_methods
+    @instance_methods ||= self.class.instance_methods(false)
+  end
+
+  def inherited_methods
+    @inherted_methods ||= self.class._inherited_methods
+  end
+
+  def get_all_methods
+    (attributes + inherited_methods + instance_methods).uniq
+  end
+
+  def set_inherited_methods_list
+    _methods = self.class.superclass.instance_methods(false) - EXCLUDED_METHODS
+    self.class._inherited_methods += _methods
+  end
+
+  def methods_to_hash
+    methods = get_all_methods - EXCLUDED_METHODS
+    methods.each do |method|
+      @json_hash[method] = self.send(method)
+    end
+  end
+
+  def set_attributes_methods
+    define_methods(definable_methods, @model)
+  end
+
+  def definable_methods
+    self.class._instance_defined_methods + self.class._model_methods
+  end
+
+  def setup_comp_objs(comp_objs_array)
+    @comp_objs = comp_objs_array.map do |obj|
+      object_instance = obj.new(@model)
+      define_methods(obj.instance_methods(false), object_instance)
+      return object_instance
+    end
+  end
+
+  def define_methods(method_names, method_owner)
+    method_names.uniq.each do |attr|
+      self.class.send(:define_method, attr) do
+        method_owner.send(attr)
+      end
+    end
+  end
+end

data/lib/view_composer/version.rb

@@ -0,0 +1,3 @@
+module ViewComposer
+  VERSION = "0.1.6"
+end

data/lib/view_composer.rb

@@ -0,0 +1,5 @@
+require "View_composer/version"
+require "View_composer/base_composer"
+require 'json'
+module ViewComposer
+end

data/view_composer.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'view_composer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "view_composer"
+  spec.version       = ViewComposer::VERSION
+  spec.authors       = ["Kory Tegman"]
+  spec.email         = ["korytegman@gmail.com"]
+
+  spec.summary       = %q{View composer helps you compose objects and serialize
+                          them. like a mix between AMS and Draper}
+  spec.description   = %q{ view composer is a dynamic way to compose view objects}
+  spec.homepage      = "http://github.com/koryteg/view_composer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: view_composer
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Kory Tegman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: " view composer is a dynamic way to compose view objects"
+email:
+- korytegman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/view_composer.rb
+- lib/view_composer/base_composer.rb
+- lib/view_composer/version.rb
+- view_composer.gemspec
+homepage: http://github.com/koryteg/view_composer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: View composer helps you compose objects and serialize them. like a mix between
+  AMS and Draper
+test_files: []