view_composer 0.1.6 → 0.1.7

checksums.yaml

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

data/Gemfile

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

data/README.md

@@ -1,8 +1,8 @@
-# ViewComposer
+# ViewComposer [![Build Status](https://travis-ci.org/koryteg/view_composer.svg?branch=master)](https://travis-ci.org/koryteg/view_composer)
 
-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.
+ViewComposer 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 ActiveModel Serializer but built on ideas of composition from Sandi Metz.
 
-This is still pre 1.0 software and the api will change.
+This is still pre-1.0 software and the API will change.
 
 ## Installation
 
@@ -22,14 +22,14 @@ Or install it yourself as:
 
 ## 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.
+create a new composer that inherits from `BaseComposer`. and use the attributes API (similar to ActiveModel::Serializer) to let your composer know what methods to respond to.
 
-``` ruby
-class PostComposer < BaseComposer
-    attributes :id, :name, :body
+```ruby
+class PostComposer < ViewComposer::BaseComposer
+  attributes :id, :name, :body
 end
 
-post_composer = PostCompser.new(model: Post.new(name: "a post") )
+post_composer = PostComposer.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}
@@ -38,21 +38,23 @@ 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
+```ruby
+class PostComposer < ViewComposer::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
+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"]
@@ -67,10 +69,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/view_composer. 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/lib/view_composer.rb

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

data/lib/view_composer/base_composer.rb

@@ -7,129 +7,131 @@ EXCLUDED_METHODS = [:to_json, :hash_attrs,
                     :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
+module ViewComposer
+  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.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 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 hash_attrs
+      @json_hash
+    end
 
-  def to_json
-    @json_hash.to_json
-  end
+    def to_json
+      @json_hash.to_json
+    end
 
-private
+    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
+    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
+      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
-  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
+    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
-  end
 
-  def instance_attributes
-    @instance_attributes ||= self.class._instance_attrs || []
-  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 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 attributes
+      @attributes ||= self.class._attributes
+    end
 
-  def instance_methods
-    @instance_methods ||= self.class.instance_methods(false)
-  end
+    def instance_methods
+      @instance_methods ||= self.class.instance_methods(false)
+    end
 
-  def inherited_methods
-    @inherted_methods ||= self.class._inherited_methods
-  end
+    def inherited_methods
+      @inherted_methods ||= self.class._inherited_methods
+    end
 
-  def get_all_methods
-    (attributes + inherited_methods + instance_methods).uniq
-  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 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)
+    def methods_to_hash
+      methods = get_all_methods - EXCLUDED_METHODS
+      methods.each do |method|
+        @json_hash[method] = self.send(method)
+      end
     end
-  end
 
-  def set_attributes_methods
-    define_methods(definable_methods, @model)
-  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 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
+    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
-  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)
+    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

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

data/view_composer.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Kory Tegman"]
   spec.email         = ["korytegman@gmail.com"]
 
-  spec.summary       = %q{View composer helps you compose objects and serialize
+  spec.summary       = %q{ViewComposer 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.description   = %q{ViewComposer is a dynamic way to compose view objects}
   spec.homepage      = "http://github.com/koryteg/view_composer"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_composer
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Kory Tegman
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: " view composer is a dynamic way to compose view objects"
+description: ViewComposer is a dynamic way to compose view objects
 email:
 - korytegman@gmail.com
 executables: []
@@ -97,6 +97,6 @@ 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
+summary: ViewComposer helps you compose objects and serialize them. like a mix between
   AMS and Draper
 test_files: []