tao_on_rails 1.0.0.beta.1 → 2.0.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5ba89a2aca102b14a98c51bcf0c5a57075cfdf34
-  data.tar.gz: dbadc3a082ab9c79cb00aa6ada0a786c445a1eb8
+SHA256:
+  metadata.gz: '0936b90ad1be05db3bc4a5c682d0145b1ccc4e5e43c3a2fb75e7837ee13cff0c'
+  data.tar.gz: 692a92c12c21146d1a25ee95b9b921b0964f4fb0f2d36540862395a74026706a
 SHA512:
-  metadata.gz: e349016c0cf23a7877da2fb3215c346749f84483f50278a997eef1e0d9c5ccf8d68899813bf561fcd65faf88aef69cb69bd8819a7193ab3dce1713855d84f813
-  data.tar.gz: d70070f3f4b1523e8ca62baf77b54475f81f962374d1451506708b6a6614d351684d8844a7d1ecb98bdcd7935fce4d05e443c6165fffaf80f16a25501c52fa53
+  metadata.gz: 112afbb785cb36242dba2ab4c2e9d085018824c891ef13984b9d6ac84ee84fa835d179824818901c6c26d31262d135e79ae38610a281624c28fa706c9eda355d
+  data.tar.gz: f3364403b5ca39a42ca533dfb2934a9fca7d1890fe16936f7712e2392e582ffe15c4c56a80ccd5d1b7daebef27a40d843a8ab5b0c8d378fe1b2be7c8841747bc

data/README.md

@@ -1,10 +1,10 @@
 # Tao on Rails [![Build Status](https://travis-ci.org/mycolorway/tao_on_rails.svg?branch=master)](https://travis-ci.org/mycolorway/tao_on_rails)
 
-[Ruby on Rails](http://rubyonrails.org/) lacks a recommended way to structure your frontend code in large project for many years. Tao on Rails is the framework to fill the gap which will modularize your page with the new [Custom Elements v1](https://developers.google.com/web/fundamentals/getting-started/primers/customelements) API.
+Tao on Rails provide both frontend and backend component solution for rails project.
 
-## Documentation
+## Frontend Components
 
-See [tao.zhiren.com](https://tao.zhiren.com) for tutorials and API reference.
+## Backend Components
 
 ## Contributing
 

data/lib/tao_on_rails/action_view/helpers.rb

@@ -16,7 +16,7 @@ module TaoOnRails
           load_tao_components
           ::ActiveSupport.run_load_hooks(:tao_components, self)
 
-          TaoOnRails::Components::Base.descendants.each do |klass|
+          TaoOnRails::BaseComponent.descendants.each do |klass|
             module_eval %Q{
               def #{klass.tag_name.underscore} *args, &block
                 #{klass.name}.new(self, *args).render(&block)

data/lib/tao_on_rails/base_component.rb

@@ -0,0 +1,121 @@
+module TaoOnRails
+  class BaseComponent
+
+    attr_reader :options, :view
+
+    delegate :component_name, :tag_prefix, :template_paths, :template_name, to: :class
+
+    def initialize view, options = {}
+      @view = view
+      @options = merge_options default_options, options
+      template_paths.unshift(@options.delete(:template_path)) if @options.key?(:template_path)
+      @tag_name = @options.delete(:tag_name)
+    end
+
+    def render &block
+      if template = find_template
+        render_template template, &block
+      else
+        view.content_tag tag_name, nil, html_options, &block
+      end
+    end
+
+    def render_template(template, &block)
+      if template.is_a?(String) || template.is_a?(Symbol)
+        template = find_template(template)
+      end
+
+      if template
+        if block_given?
+          block_content = view.capture(&block)
+          template.render(view, {component: self, block_given: true}) do |*name|
+            view._layout_for(*name) {block_content}
+          end
+        else
+          template.render(view, {component: self})
+        end
+      end
+    end
+
+    def html_options
+      @html_options ||= transform_html_options options
+    end
+
+    def tag_name
+      @tag_name || self.class.tag_name
+    end
+
+    def self.tag_name
+      @tag_name ||= "#{self.tag_prefix}-#{self.component_name.to_s.dasherize}"
+    end
+
+    def self.component_name
+      @component_name ||= self.name.underscore.split('/').map(&:singularize).join('_')
+        .gsub(/(.+)_component$/, '\1')
+        .gsub(/^#{Regexp.quote(self.tag_prefix.to_s.underscore)}_(.+)/, '\1')
+    end
+
+    def self.tag_prefix
+      :tao
+    end
+
+    def self.template_paths
+      @template_paths ||= [
+        "components/#{self.name.deconstantize.underscore}",
+        "#{self.name.deconstantize.underscore}/components"
+      ]
+    end
+
+    def self.template_name
+      @template_name ||= self.name.demodulize.underscore.gsub(/(.+)_component$/, '\1')
+    end
+
+    private
+
+    def default_options
+      {}
+    end
+
+    def merge_options options, other_options
+      options.merge(other_options) { |key, old_val, new_val|
+        if key.to_s == 'class'
+          old_val = old_val.split(' ') if old_val.is_a? String
+          new_val = new_val.split(' ') if new_val.is_a? String
+          Array(old_val) + Array(new_val)
+        elsif old_val.is_a?(Hash) && old_val.is_a?(Hash)
+          old_val.merge! new_val
+        else
+          new_val
+        end
+      }
+    end
+
+    def transform_html_options options, other_options = nil
+      if other_options
+        options = merge_options options, other_options
+      end
+
+      options.transform_keys { |key|
+        key.to_s.dasherize.to_sym
+      }.transform_values { |value|
+        case value
+        when true
+          ''
+        when false
+          nil
+        else
+          value
+        end
+      }
+    end
+
+    def find_template(name = template_name)
+      view.lookup_context.find_all(name, template_paths, true, template_keys, formats: [:html]).first
+    end
+
+    def template_keys
+      @template_keys ||= [:component, :block_given]
+    end
+
+  end
+end

data/lib/tao_on_rails/version.rb

@@ -1,3 +1,3 @@
 module TaoOnRails
-  VERSION = "1.0.0.beta.1"
+  VERSION = "2.0.0-beta.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tao_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.1
+  version: 2.0.0.pre.beta.1
 platform: ruby
 authors:
 - Siyuan Liu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-06 00:00:00.000000000 Z
+date: 2019-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,9 +59,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
-description: Ruby on Rails lacks a recommended way to structure your frontend code
-  for many years. Tao on Rails is the framework to fill the gap which will modularize
-  your page with the new Custom Elements v1 API.
+description: Tao on Rails provide frontend component based on Custom Elements v1 and
+  backend component for rendering.
 email:
 - farthinker@mycolorway.com
 - t@mycolorway.com
@@ -72,20 +71,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/generators/tao/component/USAGE
-- lib/generators/tao/component/component_generator.rb
-- lib/generators/tao/component/templates/component.rb.erb
-- lib/generators/tao/install/USAGE
-- lib/generators/tao/install/install_generator.rb
-- lib/generators/tao/install/templates/app/assets/javascripts/application.coffee
-- lib/generators/tao/install/templates/app/assets/stylesheets/_globals.scss
-- lib/generators/tao/install/templates/app/assets/stylesheets/application.scss
-- lib/generators/tao/install/templates/app/components/application_component.rb
-- lib/generators/tao/install/templates/app/views/layouts/application.html.erb
 - lib/tao_on_rails.rb
 - lib/tao_on_rails/action_view/helpers.rb
-- lib/tao_on_rails/components/base.rb
-- lib/tao_on_rails/components/page_component.rb
+- lib/tao_on_rails/base_component.rb
 - lib/tao_on_rails/engine.rb
 - lib/tao_on_rails/version.rb
 homepage: https://github.com/mycolorway/tao_on_rails
@@ -107,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: The missing frontend solution for Rails project
+summary: The component solution for Rails project
 test_files: []

data/lib/generators/tao/component/USAGE

@@ -1,10 +0,0 @@
-Description:
-    Generate controller files
-
-Example:
-    `rails generate tao:component posts/autosave`
-
-    Create file:
-        app/components/posts/autosave_component.rb
-        app/assets/javascripts/posts/components/autosave.coffee
-        app/assets/stylesheets/posts/components/autosave.scss

data/lib/generators/tao/component/component_generator.rb

@@ -1,20 +0,0 @@
-require 'rails/generators'
-
-module Tao
-  module Generators
-
-    class ComponentGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path('../templates', __FILE__)
-
-      check_class_collision suffix: "Component"
-
-      attr_reader :component_name
-
-      def create_component_file
-        @component_name = class_name.underscore.split('/').map(&:singularize).join('_')
-        template "component.rb.erb", File.join('app/components', class_path, "#{file_name}_component.rb")
-      end
-
-    end
-  end
-end

data/lib/generators/tao/component/templates/component.rb.erb

@@ -1,3 +0,0 @@
-class <%= class_name %>Component < ApplicationComponent
-
-end

data/lib/generators/tao/install/USAGE

@@ -1,12 +0,0 @@
-Description:
-    install files of tao.
-
-Example:
-    `rails generate tao:install`
-
-    Create or update files:
-        app/assets/javascripts/application.coffee
-        app/assets/stylesheets/application.scss
-        app/assets/stylesheets/_globals.scss
-        app/views/layouts/application.html.erb
-        app/components/application_component.rb

data/lib/generators/tao/install/install_generator.rb

@@ -1,37 +0,0 @@
-require 'rails/generators'
-
-module Tao
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
-
-      def install_tao
-        assert_rails_version
-
-        gem 'tao_on_rails'
-
-        # remove_file 'app/assets/javascripts/cable.js'
-        # remove_file 'app/assets/javascripts/application.js'
-        # remove_file 'app/assets/stylesheets/application.css'
-        #
-        # template 'app/assets/javascripts/application.coffee'
-        # template 'app/assets/stylesheets/application.scss'
-        # template 'app/assets/stylesheets/_globals.scss'
-        #
-        # template 'app/views/layouts/application.html.erb', force: true
-
-        template 'app/components/application_component.rb'
-      end
-
-      private
-
-      def assert_rails_version
-        requirement = Gem::Requirement.new('>= 5.0.0')
-        rails_version = Gem::Version.new(Rails::VERSION::STRING)
-        return if requirement.satisfied_by?(rails_version)
-        fail Rails::Generators::Error, 'Rails >= 5.0.0 is required'
-      end
-
-    end
-  end
-end

data/lib/generators/tao/install/templates/app/assets/javascripts/application.coffee

@@ -1,12 +0,0 @@
-#= require tao
-#= require action_cable
-#= require_self
-#= require_tree .
-
-class Application extends TaoApplication
-
-  _init: ->
-    super
-    @cable = ActionCable.createConsumer()
-
-window.app = new Application()

data/lib/generators/tao/install/templates/app/assets/stylesheets/_globals.scss

@@ -1 +0,0 @@
-// put global sass variables, mixins, functions here

data/lib/generators/tao/install/templates/app/assets/stylesheets/application.scss

@@ -1,2 +0,0 @@
-//= require tao
-//= require_tree ./

data/lib/generators/tao/install/templates/app/components/application_component.rb

@@ -1,7 +0,0 @@
-class ApplicationComponent < TaoOnRails::Components::Base
-
-  def self.tag_prefix
-    :app
-  end
-
-end

data/lib/generators/tao/install/templates/app/views/layouts/application.html.erb

@@ -1,20 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <title><%%= content_for(:title) || 'A Tao on Rails Project' %></title>
-    <%%= csrf_meta_tags %>
-
-    <%%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
-    <%%= content_for(:stylesheet) %>
-
-    <%%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
-    <%%= content_for(:javascript) %>
-  </head>
-
-  <body>
-    <%%= tao_page layout: 'default' do %>
-      <%%= yield %>
-    <%% end %>
-  </body>
-</html>

data/lib/tao_on_rails/components/base.rb

@@ -1,136 +0,0 @@
-module TaoOnRails
-  module Components
-    class Base
-
-      attr_reader :options, :view
-
-      delegate :component_name, :tag_prefix, :template_paths, :template_name, to: :class
-
-      def initialize view, options = {}
-        @view = view
-        @options = merge_options default_options, options
-        template_paths.unshift(@options.delete(:template_path)) if @options.key?(:template_path)
-        @tag_name = @options.delete(:tag_name)
-      end
-
-      def render &block
-        if template = find_template
-          render_template template, &block
-        else
-          view.content_tag tag_name, nil, html_options, &block
-        end
-      end
-
-      def render_template(template, &block)
-        if template.is_a?(String) || template.is_a?(Symbol)
-          template = find_template(template)
-        end
-
-        if template
-          if block_given?
-            block_content = view.capture(&block)
-            template.render(view, {component: self, block_given: true}) do |*name|
-              view._layout_for(*name) {block_content}
-            end
-          else
-            template.render(view, {component: self})
-          end
-        end
-      end
-
-      def translate key, options = {}
-        keys = [].tap do |result|
-          component_class = self.class
-          until component_class == TaoOnRails::Components::Base
-            scope = component_class.name.underscore.split('/').join('.').gsub(/(.+)_component$/, '\1')
-            result << "#{scope}.#{key}".to_sym
-            component_class = component_class.superclass
-          end
-        end
-        I18n.t(keys.shift, options.merge!(default: keys))
-      end
-      alias_method :t, :translate
-
-      def html_options
-        @html_options ||= transform_html_options options
-      end
-
-      def tag_name
-        @tag_name || self.class.tag_name
-      end
-
-      def self.tag_name
-        @tag_name ||= "#{self.tag_prefix}-#{self.component_name.to_s.dasherize}"
-      end
-
-      def self.component_name
-        @component_name ||= self.name.underscore.split('/').map(&:singularize).join('_')
-          .gsub(/(.+)_component$/, '\1')
-          .gsub(/^#{Regexp.quote(self.tag_prefix.to_s.underscore)}_(.+)/, '\1')
-      end
-
-      def self.tag_prefix
-        :tao
-      end
-
-      def self.template_paths
-        @template_paths ||= [
-          "components/#{self.name.deconstantize.underscore}",
-          "#{self.name.deconstantize.underscore}/components"
-        ]
-      end
-
-      def self.template_name
-        @template_name ||= self.name.demodulize.underscore.gsub(/(.+)_component$/, '\1')
-      end
-
-      private
-
-      def default_options
-        {}
-      end
-
-      def merge_options options, other_options
-        options.merge(other_options) { |key, old_val, new_val|
-          if key.to_s == 'class'
-            old_val = old_val.split(' ') if old_val.is_a? String
-            new_val = new_val.split(' ') if new_val.is_a? String
-            Array(old_val) + Array(new_val)
-          elsif old_val.is_a?(Hash) && old_val.is_a?(Hash)
-            old_val.merge! new_val
-          else
-            new_val
-          end
-        }
-      end
-
-      def transform_html_options options, other_options = nil
-        if other_options
-          options = merge_options options, other_options
-        end
-
-        options.transform_keys { |key|
-          key.to_s.dasherize.to_sym
-        }.transform_values { |value|
-          case value
-          when true
-            ''
-          when false
-            nil
-          else
-            value
-          end
-        }
-      end
-
-      def find_template(name = template_name)
-        view.lookup_context.find_all(name, template_paths, true, template_keys, formats: [:html]).first
-      end
-
-      def template_keys
-        @template_keys ||= [:component, :block_given]
-      end
-
-    end
-  end
-end

data/lib/tao_on_rails/components/page_component.rb

@@ -1,27 +0,0 @@
-module TaoOnRails
-  module Components
-    class PageComponent < Base
-      attr_reader :page_id
-
-      def initialize view, options = {}
-        @page_id = view.page_id
-        super
-      end
-
-      def render &block
-        view.content_tag "#{view.page_id}-page", options, &block
-      end
-
-      def self.component_name
-        :page
-      end
-
-      private
-
-      def default_options
-        {class: ['tao-page', "#{@page_id}-page"]}
-      end
-
-    end
-  end
-end