opencomponents-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d47325974d4ae94b62bf8fcb3ae04451fc25b51
+  data.tar.gz: 0de0e3246eb1f39ec2e895ddbf971c7aeb94fdb9
+SHA512:
+  metadata.gz: 1f7f02a3300533e112efdc920cede57711ae24395e707f9403846dccd4649657d68ca6ff584bdc988e6f99b947e3ecbfb7115a1e4de8a25cf3bc76f70d006ab9
+  data.tar.gz: ca4d058d2b3cb2e838d2297546c3386ce4b5221049febcaa019d22f65c37fea57fa062ec61cf3bf33c5e06768f1674a2256229fb1d468eb6dae6b7d50ea72aa3

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 OpenTable
+
+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,74 @@
+# OpenComponents::Rails
+[![Build Status](https://travis-ci.org/opentable/opencomponents-rails.svg?branch=master)][1]
+
+[1]:https://travis-ci.org/opentable/opencomponents-rails
+
+OpenComponents for Rails. This gem provides view helper methods for component
+rendering on both server- and client-side.
+
+## Getting Started
+Add the gem to your Gemfile and run `bundle install`:
+
+```ruby
+gem 'opencomponents-rails'
+```
+
+### Configuration
+All configuration options are set through Rails environment configuration files.
+
+```ruby
+# production.rb
+
+# Sets the registry URL to fetch components from. Defaults to http://localhost:3030.
+config.opencomponents.registry = 'http://my.awesome.registry'
+
+# Determines whether rendering should be handed off to the browser if server-side
+# rendering fails. Defaults to true.
+config.opencomponents.enable_client_failover = true
+
+# Sets the timeout length (in seconds) for registry requests. Defaults to 5.
+config.opencomponents.request_timeout = 10
+```
+
+## Rendering
+`OpenComponents::Rails` supports both server- and client-side rendering of components.
+By default, the gem will fall back to client-side rendering if a server-side registry
+request times out. If client-side failover if disabled, an error will be raised instead.
+This is configurable using the `enable_client_failover` option.
+
+### Client-Side Rendering
+The OpenComponents client-side javascript library is bundled with this gem for inclusion
+in the asset compilation process. To enable client-side rendering through the asset
+pipeline, add the library to your javascript manifest:
+
+```javascript
+//= require opencomponents
+```
+
+Once that's done, you can use the `oc_component_tag` method in your views. You can either
+pass the method a fully formed `href` attribute or use the same options as `OpenComponents`
+[Renderer][2].
+```erb
+<%= oc_component_tag('my-sweet-component', href: 'http://localhost:3030/my-sweet-component/1.0.1?name=Zan') %>
+
+<%= oc_component_tag('my-sweet-component', params: {name: 'Zan'}, version: '1.0.1') %>
+```
+
+Components using this tag will be automatically rendered on DOM load.
+
+### Server-Side Rendering
+In your view, simply call `render_component`:
+
+```erb
+<%= render_component('my-sweet-component', params: {name: 'Zan'}, version: '1.0.1') %>
+```
+
+The method accepts the same options as the `OpenComponents` [Renderer][2].
+
+[2]:http://www.rubydoc.info/gems/opencomponents/OpenComponents/Renderer
+
+## Contributing
+Would be pretty cool of you. Open an Issue or PR if you find bugs or have ideas for improvements.
+
+## License
+Copyright 2015 OpenTable. See LICENSE for details.

data/lib/opencomponents-rails.rb

@@ -0,0 +1 @@
+require 'opencomponents/rails'

data/lib/opencomponents/rails.rb

@@ -0,0 +1,6 @@
+require 'opencomponents'
+
+require 'opencomponents/rails/engine'
+require 'opencomponents/rails/railtie'
+require 'opencomponents/rails/renderer'
+require 'opencomponents/rails/version'

data/lib/opencomponents/rails/engine.rb

@@ -0,0 +1,4 @@
+module OpenComponents::Rails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/opencomponents/rails/railtie.rb

@@ -0,0 +1,20 @@
+module OpenComponents::Rails
+  class Railtie < ::Rails::Railtie
+    config.opencomponents = ActiveSupport::OrderedOptions.new
+
+    config.opencomponents.registry = OpenComponents::DEFAULT_REGISTRY
+    config.opencomponents.enable_client_failover = true
+    config.opencomponents.request_timeout = OpenComponents::DEFAULT_TIMEOUT
+
+    initializer 'opencomponents.configure' do |app|
+      OpenComponents.configure do |config|
+        config.registry = app.config.opencomponents.registry
+        config.timeout  = app.config.opencomponents.request_timeout
+      end
+    end
+
+    initializer 'opencomponents.view_helpers' do
+      ActionView::Base.send :include, OpenComponents::Rails::Renderer
+    end
+  end
+end

data/lib/opencomponents/rails/renderer.rb

@@ -0,0 +1,66 @@
+module OpenComponents::Rails
+  module Renderer
+    include ::OpenComponents::Renderer
+
+    include ::ActionView::Helpers::TagHelper
+
+    # Returns a rendered component.
+    #
+    #   render_component('my-component')
+    #   # => <oc-component href="http://localhost:3030/my-component">...</oc-component>
+    #
+    # Also accepts options for "params", "version", and "headers".
+    #
+    #   render_component('my-component',
+    #     params: {name: 'Zan'},
+    #     version: '1.0.2',
+    #     headers: {accept_language: 'emoji'}
+    #   )
+    #   # => <oc-component href="http://localhost:3030/my-component/1.0.2?name=Zan">...</oc-component>
+    #
+    # Raises an error if the registry request times out and client failover is
+    # disabled, otherwise will return an unrendered <oc-component> tag for
+    # client-side rendered.
+    def render_component(component, opts = {})
+      super(component, opts).html_safe
+    rescue OpenComponents::RegistryTimeout
+      config = ::Rails.application.config.opencomponents
+
+      raise unless config.enable_client_failover
+
+      oc_component_tag(component, opts)
+    end
+
+    # Returns an unrendered oc-component tag for client-side rendering.
+    #
+    #   oc_component_tag('my-component')
+    #   # => <oc-component href="localhost:3030/my-component" />
+    #
+    # Also accepts options for "href", "params", and "version". "params" and
+    # "version" are ignored if "href" is passed to the method. If no href is
+    # passed, the method attempts to build a valid URL using the configured
+    # OC registry, component name, and params and version if they're available.
+    #
+    #   oc_component_tag('my-component', params: {name: 'Zan'}, version: '1.0.2')
+    #   # => <oc-component href="http://localhost:3030/my-component/1.0.2?name=Zan">
+    #
+    #   oc_component_tag('my-component', href: 'http://some.registry/my-component')
+    #   # => <oc-component href="http://some.registry/my-component" />
+    def oc_component_tag(component, opts = {})
+      opts = opts.with_indifferent_access
+      options = opts.reject { |k, _| %w(params version).include? k }
+
+      unless options[:href]
+        registry = ::Rails.application.config.opencomponents.registry
+
+        options[:href] = File.join(
+          registry, component, opts[:version].to_s
+        )
+
+        options[:href] << "?#{opts[:params].to_param}" if opts[:params]
+      end
+
+      tag('oc-component', options)
+    end
+  end
+end

data/lib/opencomponents/rails/version.rb

@@ -0,0 +1,5 @@
+module OpenComponents
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/opencomponents-rails.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'opencomponents/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'opencomponents', '~> 0.4.0'
+  spec.add_dependency 'railties',   '~> 4.1', '< 5.0.0.alpha'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+
+  spec.authors       = ['Todd Bealmear']
+  spec.description   = %q{Renders OpenComponents in your Rails views.}
+  spec.email         = ['tbealmear@opentable.com']
+  spec.files         = %w(LICENSE README.md opencomponents-rails.gemspec)
+  spec.files        += Dir.glob('lib/**/*.rb')
+  spec.homepage      = 'https://github.com/opentable/opencomponents-rails'
+  spec.licenses      = ['MIT']
+  spec.name          = 'opencomponents-rails'
+  spec.require_paths = ['lib']
+  spec.summary       = spec.description
+  spec.version       = OpenComponents::Rails::VERSION
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: opencomponents-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Todd Bealmear
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opencomponents
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.alpha
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.alpha
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: Renders OpenComponents in your Rails views.
+email:
+- tbealmear@opentable.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/opencomponents-rails.rb
+- lib/opencomponents/rails.rb
+- lib/opencomponents/rails/engine.rb
+- lib/opencomponents/rails/railtie.rb
+- lib/opencomponents/rails/renderer.rb
+- lib/opencomponents/rails/version.rb
+- opencomponents-rails.gemspec
+homepage: https://github.com/opentable/opencomponents-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Renders OpenComponents in your Rails views.
+test_files: []