compositor-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14194e2d62f07dd1a73e94389bcd813b03b6e1f9
+  data.tar.gz: e070253a8a7681d41add07f7871baa3061ef5fa2
+SHA512:
+  metadata.gz: 3318b786d79ffe6c98e9368aac81d9a5341e4d4d0358480d01825a482dafb3aa5972acd24c9625d54b62f7705cfaea4ce0775df742eafe0abfb80e75e666838d
+  data.tar.gz: 9e935e9bfc5b3b418d44d69cd510e4fbfa737a5b73fe40e870a2e77f2aab46d2aac824d5b817990791ff07ddabfdb8876758c545e6e98495cfc06adf9bd20fc7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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,87 @@
+# Compositor::Rails
+
+Extensions to compositor that allow views to be created and used inside of Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'compositor-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install compositor-rails
+
+## Usage
+
+Given a `UserCompositor` as follows:
+
+```ruby
+# File: app/compositors/user_compositor.rb
+class UserCompositor < Compositor::Leaf
+  attr_accessor :user
+
+  def initialize(context, user, attrs = {})
+    super(context, attrs)
+    self.user = user
+  end
+
+  def to_hash
+    {
+        id: user.id,
+        username: user.username,
+        location: user.location,
+        bio: user.bio,
+        url: user.url,
+        image_url: context.image_path(user.avatar),  # using context to generate URL path from routes
+        ...
+    }
+  end
+end
+```
+
+To render a list of users, create a view and then write out the DSL as you normally would.
+
+```ruby
+# File: app/views/users/index.json.compositor
+list :collection: @users, root: :users do |u|
+  user: u
+end
+```
+
+### Partials
+
+Let's move the rendering of a user into a partial.
+
+```ruby
+# File: app/views/users/index.json.compositor
+list :collection: @users, root: :users do |u|
+  partial! 'show', user: user
+end
+```
+
+```ruby
+# File: app/views/users/show.json.compositor
+user: user
+```
+
+Notes on using partials:
+
+1. Try and keep them to a minimum. The whole point of compositor is to reduce complexity
+   in the composition stage. A enourmous number of partials might just mean a need for
+   another compositor.
+2. Normal Rails partials support collections. These do not as compositor requires you to
+   explicitly define your collection rendering. Of course a partial can render a collection
+   itself, by using the normal compositor list/map functionality.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/compositor-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/compositor-rails.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'compositor/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "compositor-rails"
+  spec.version       = Compositor::Rails::VERSION
+  spec.authors       = ["Paul Henry"]
+  spec.email         = ["paul@wanelo.com"]
+  spec.summary       = %q{ActionView extensions to compositor.}
+  spec.description   = %q{VIEWS WITH COMPOSITOR YAY}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'compositor'
+  spec.add_dependency 'activesupport', '>= 3.0.0'
+
+  spec.add_development_dependency "actionpack"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "railties"
+end

data/lib/compositor/rails.rb

@@ -0,0 +1,10 @@
+require "compositor/rails/version"
+
+module Compositor
+  module Rails
+    # Your code goes here...
+  end
+end
+
+require "compositor/rails/dsl"
+require "compositor/rails/handler"

data/lib/compositor/rails/dsl.rb

@@ -0,0 +1,63 @@
+require 'compositor'
+
+module Compositor
+  module Rails
+    class DSL < Compositor::DSL
+
+      def initialize(*args)
+        super
+        @partial_variable_counter = 0
+      end
+
+      def partial!(name_or_options, locals = {})
+        case name_or_options
+        when ::Hash
+          # partial! partial: 'name', locals: { foo: 'bar' }
+          options = name_or_options
+        else
+          # partial! 'name', foo: 'bar'
+          options = { partial: name_or_options, locals: locals }
+          as = locals.delete(:as)
+          options[:as] = as if as.present?
+          options[:collection] = locals[:collection] if locals.key?(:collection)
+        end
+
+        _handle_partial_options options
+      end
+
+      private
+
+      def _handle_partial_options(options)
+        options.reverse_merge! locals: {}
+        options.reverse_merge! ::Compositor::Rails::Handler.default_partial_options
+        _render_partial options
+      end
+
+      def _render_partial(options)
+        template = _lookup_context.find_template(options[:partial],
+                                                 [],
+                                                 true,
+                                                 [],
+                                                 options)
+
+        instance_eval _compile_partial(template, options)
+      end
+
+      def _compile_partial(template, options)
+        source = ""
+        options[:locals].each do |k, v|
+          name = "@partial_#{@partial_variable_counter}"
+          instance_variable_set name, v
+          source << "#{k} = #{name};"
+          @partial_variable_counter += 1
+        end
+        source << template.source
+        source
+      end
+
+      def _lookup_context
+        context.controller.view_renderer.lookup_context
+      end
+    end
+  end
+end

data/lib/compositor/rails/handler.rb

@@ -0,0 +1,20 @@
+module Compositor
+  module Rails
+    class Handler
+      cattr_accessor :default_format
+      self.default_format = Mime::JSON
+
+      def self.default_partial_options
+        { format: self.default_format }
+      end
+
+      def self.call(template)
+        # this juggling is required to keep line numbers right in the error
+        %{Compositor::Rails::DSL.create(self) do #{template.source}
+          end.to_json}
+      end
+    end
+  end
+end
+
+ActionView::Template.register_template_handler :compositor, Compositor::Rails::Handler

data/lib/compositor/rails/version.rb

@@ -0,0 +1,5 @@
+module Compositor
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/spec/lib/compositor/rails/dsl_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Compositor::Rails::DSL do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'action_view'
+require 'action_controller'
+require 'action_view/testing/resolvers'
+require 'active_support/cache'
+require 'json'
+require 'rails/railtie'
+require 'rspec/rails'
+require 'compositor/rails'
+
+require 'support/compositors'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/compositors.rb

@@ -0,0 +1,12 @@
+require 'compositor'
+require 'oj'
+
+class StringCompositor < Compositor::Leaf
+  attr_accessor :string
+  
+  def to_hash
+    with_root_element do
+      { 'string' => string.to_s }
+    end
+  end
+end

data/spec/views/view_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'Compositor views', type: :view do  
+
+  let(:source) do
+    <<-RUBY
+    string string: 'hello'
+    RUBY
+  end
+  
+  let(:partials) {
+    {'test.json.compositor' => source}
+  }
+  
+  let(:result) { JSON.parse(ActionView::Template.new(source, 'test', Compositor::Rails::Handler, :virtual_path => 'test').render(self, {}).strip) }
+  
+  before do
+    lookup_context.view_paths = [ActionView::FixtureResolver.new(partials)]
+  end
+  
+  it 'renders the compositor' do
+    expect(result['string']).to eq('hello')
+  end
+
+
+  describe '#partial' do
+    let(:source) do
+      <<-RUBY
+        partial! 'boom', explosion: 'hai' 
+      RUBY
+    end
+
+    let(:partial) do
+      <<-RUBY
+        string string: explosion
+      RUBY
+    end
+
+    let(:partials) { { 'test.json.compositor' => source, '_boom.json.compositor' => partial } }
+
+    it 'renders the partial' do
+      expect(result['string']).to eq('hai')
+    end
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: compositor-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Henry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: compositor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: rspec-rails
+  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: railties
+  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: VIEWS WITH COMPOSITOR YAY
+email:
+- paul@wanelo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- compositor-rails.gemspec
+- lib/compositor/rails.rb
+- lib/compositor/rails/dsl.rb
+- lib/compositor/rails/handler.rb
+- lib/compositor/rails/version.rb
+- spec/lib/compositor/rails/dsl_spec.rb
+- spec/spec_helper.rb
+- spec/support/compositors.rb
+- spec/views/view_spec.rb
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: ActionView extensions to compositor.
+test_files:
+- spec/lib/compositor/rails/dsl_spec.rb
+- spec/spec_helper.rb
+- spec/support/compositors.rb
+- spec/views/view_spec.rb
+has_rdoc: