action_component 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 743d176be9df1da38d3b0aa1b4609505ea8de03a
+  data.tar.gz: 7be1460ea0d7b0f68e58bb90a70ec78ff8ee6013
+SHA512:
+  metadata.gz: 92ba9a92079dc33beaac95607f98dcad316b559540dfcc54be48cec5a7bb3f4759cf283fd8af3292fcc8e914777dfa77b36fd9be0ce397432d64ea5e565dba1c
+  data.tar.gz: 7e540ab4fc1fd22440286c3e1bee0293e1f069f7c2f59fe03afb90851e738d9148202374260d0dc661dfc1596bde57625b3fb7cc110abf51699a5026b7b9d685

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,87 @@
+# ActionComponent
+
+A React-style component system for Ruby on Rails.
+
+This gem should be considered "alpha" as it currently has no tests.
+
+## Examples
+
+### Example 1: Integrating components into a standard Rails app
+
+```html+erb
+<!-- app/views/posts/show.html.erb -->
+
+<div class="post">
+  <h2><%= @post.title %></h2>
+  <%= render_component AuthorComponent, author: @post.author %>
+
+  <%= simple_format @post.content %>
+</div>
+```
+
+```ruby
+# app/components/author_component.rb
+
+class AuthorComponent < ActionComponent::Base
+  def load
+    @post_count = @author.posts.published.count
+  end
+
+  def view
+    div(class: 'author') do
+      insert image_tag(@author, alt: @author.name)
+
+      div link_to(@author.name, @author), class: 'name'
+
+      div pluralize(@post_count, 'post'), class: 'post-count'
+
+      stars
+    end
+  end
+
+  def stars
+    div class: 'stars' do
+      @author.stars.times { span "*" }
+    end
+  end
+end
+```
+
+### Example 2: Using components instead of views
+
+```ruby
+# app/controllers/posts_controller.rb
+
+class PostsController < ApplicationController
+  def show
+    post = Post.find(params[:id])
+
+    render_component PostComponent, post: post
+  end
+end
+```
+
+```ruby
+# app/components/post_component.rb
+
+class PostComponent < ActionComponent::Base
+  def view
+    div(class: 'post') do
+      h2(@post.title)
+
+      component AuthorComponent, author: @post.author
+
+      insert simple_format(@post.content)
+    end
+  end
+end
+```
+
+## Contributing
+
+Pull requests welcome!  If you're thinking of contributing a new feature, or
+significantly changing an existing feature, please propose it as an issue.
+
+## Licence
+
+MIT.  Copyright Roger Nesbitt.

data/action_component.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "action_component/version"
+
+Gem::Specification.new do |s|
+  s.name        = "action_component"
+  s.version     = ActionComponent::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.authors     = ["Roger Nesbitt"]
+  s.email       = ["roger@seriousorange.com"]
+  s.homepage    = "https://github.com/mogest/action_component"
+  s.summary     = %q{React-style components for Rails}
+  s.description = %q{React-style components for Rails, mixing together the controller and a DSL language for HTML views.}
+
+  s.add_dependency "actionpack", ">= 4"
+  s.add_dependency "activesupport", ">= 4"
+
+  s.add_development_dependency "rspec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/lib/action_component.rb

@@ -0,0 +1,8 @@
+module ActionComponent
+end
+
+require 'action_component/action_controller_rendering'
+require 'action_component/action_view_rendering'
+require 'action_component/base'
+require 'action_component/railtie'
+require 'action_component/version'

data/lib/action_component/action_controller_rendering.rb

@@ -0,0 +1,21 @@
+module ActionComponent
+  module ActionControllerRendering
+    private
+
+    def render_component(component_class, opts = {})
+      @_component_class = component_class
+      @_component_options = opts
+
+      render_opts = {
+        inline: "<% render_component(@_component_class, @_component_options) %>",
+        layout: true
+      }
+
+      [:content_type, :layout, :location, :status, :formats].each do |option|
+        render_opts[option] = opts[option] if opts.member?(option)
+      end
+
+      render render_opts
+    end
+  end
+end

data/lib/action_component/action_view_rendering.rb

@@ -0,0 +1,7 @@
+module ActionComponent
+  module ActionViewRendering
+    def render_component(component_class, opts = {})
+      component_class.render(self, opts)
+    end
+  end
+end

data/lib/action_component/base.rb

@@ -0,0 +1,107 @@
+module ActionComponent
+  RenderError = Class.new(StandardError)
+
+  ELEMENTS = %w(
+    html head title base link meta style
+    script noscript
+    body section nav article aside h1 h2 h3 h4 h5 h6 hgroup header footer address
+    p hr br pre blockquote ol ul li dl dt dd figure figcaption div
+    a em strong small s cite q dfn abbr time code var samp kbd sub sup i b u mark rt rp bdi bdo span
+    ins del
+    img iframe embed object param video audio source track canvas map area
+    table caption colgroup col tbody thead tfoot tr td th
+    form fieldset legend label input button select datalist optgroup option textarea keygen output progress meter
+    details summary command menu
+  )
+
+  class Base
+    delegate :concat, to: :@_view
+
+    def self.define_tags(*element_names)
+      element_names.each do |element_name|
+        define_method(element_name) do |*args, &block|
+          element(element_name, *args, &block)
+        end
+
+        private element_name
+      end
+    end
+
+    define_tags *ActionComponent::ELEMENTS
+
+    def self.render(view, opts = {})
+      component = new(view, opts)
+      component.load
+      component.view
+    end
+
+    def initialize(view, opts = {})
+      opts.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      @_view = view
+    end
+
+    def load
+    end
+
+    def view
+      raise "#{self.class.name} must define a view method to be a valid component"
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      if @_view.respond_to?(method)
+        @_view.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def render(*args)
+      @_view.concat(@_view.render(*args))
+    end
+
+    def component(component, opts = {})
+      self.class.render(@_view, opts)
+    end
+
+    alias_method :render_component, :component
+
+    def text(content)
+      @_view.concat content
+    end
+
+    alias_method :text_node, :text
+    alias_method :insert, :text
+
+    def doctype(text = "html")
+      @_view.concat("<!doctype #{h(text)}>".html_safe)
+    end
+
+    def element(name, first = nil, second = nil, &block)
+      if first.is_a?(Hash)
+        opts = first
+      else
+        opts = second
+        text = first
+      end
+
+      output = if text && block
+        raise ActionComponent::RenderError, "An element cannot have both text and a block supplied; choose one or the other"
+      elsif text
+        @_view.content_tag name, text, opts
+      elsif block
+        @_view.content_tag name, opts, &block
+      else
+        @_view.tag name, opts
+      end
+
+      @_view.concat(output)
+
+      nil
+    end
+  end
+end

data/lib/action_component/railtie.rb

@@ -0,0 +1,15 @@
+module ActionComponent
+  class Railtie < Rails::Railtie
+    initializer "action_component.add_to_action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include ActionComponent::ActionControllerRendering
+      end
+    end
+
+    initializer "action_component.add_to_action_view" do
+      ActiveSupport.on_load(:action_view) do
+        include ActionComponent::ActionViewRendering
+      end
+    end
+  end
+end

data/lib/action_component/version.rb

@@ -0,0 +1,3 @@
+module ActionComponent
+	VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: action_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roger Nesbitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !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'
+description: React-style components for Rails, mixing together the controller and
+  a DSL language for HTML views.
+email:
+- roger@seriousorange.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- action_component.gemspec
+- lib/action_component.rb
+- lib/action_component/action_controller_rendering.rb
+- lib/action_component/action_view_rendering.rb
+- lib/action_component/base.rb
+- lib/action_component/railtie.rb
+- lib/action_component/version.rb
+homepage: https://github.com/mogest/action_component
+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.5.1
+signing_key: 
+specification_version: 4
+summary: React-style components for Rails
+test_files: []