tao_on_rails 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1aec7845926da7ba72c3a2adc0375801cc91465b
-  data.tar.gz: dc8dffdd444cf419667b54731aab0c59bfbe3144
+  metadata.gz: 9bafebffce03548b6276eaab7c9af6f5cf015fd3
+  data.tar.gz: 02f27e9957ae1e1387420e4f1d85ccbcdf5d40d5
 SHA512:
-  metadata.gz: d6e2dc63d51c677dee8eacc042b725b45f91a286ee350115c6e8cd9dab83c293b113341f682b4715c7e7a4a36b78b1dbd7d38a507c031e0c8bc74c05e850e3c2
-  data.tar.gz: f1b51e8276c9b98dd1df1ac5f95f1f98419bfac31e888da57515b00b7b453451364b54ddadea364d202b9aa1f6927f03a94310ee6ceb6f37d1429e827baaef19
+  metadata.gz: b3f076acc51ff5ae2f085332db2f13983824063ab03ecfa2fb4410324c80c764b6706b0bfda767cc3ca30ac0b7f21ac633e12e735d520c242b0691f3eaebbea2
+  data.tar.gz: 9d08e93ae5ef79aa4214c8ad0a9a4aedb2a5e2bbc236c67ed2870fbfa74f7e487576b72027cb98afe934e624c3fce4be639456d60f73705cd3a8247f862e58e2

data/README.md

@@ -2,43 +2,14 @@
 
 [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.
 
-## Usage
-
-Create new Tao on Rails application with following commands:
-
-```bash
-rails new app_name -m https://git.io/vSvyw
-```
-
-Several generators are available for you to quickly start your work:
-
-* tao:assets
-* tao:view
-* tao:controller
-* tao:component
-* tao:locale
-* tao:channel
-* tao:scaffold
-
-See `rails g tao:xxx --help` for more information.
-
-## Plugin
-
-Start writing plugin for Tao on Rails with following commands:
-
-```bash
-rails plugin new plugin_name -m https://git.io/vSvyy
-```
-
 ## Documentation
 
-See [wiki](https://github.com/mycolorway/tao_on_rails/wiki) for tutorials and API reference.
+See [tao.zhiren.com](https://tao.zhiren.com) for tutorials and API reference.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mycolorway/tao_on_rails. 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/assets/javascripts/tao/attribute_manager.coffee

@@ -38,7 +38,7 @@ class TaoAttributeManager extends TaoModule
     get: (element, name, options) ->
       value = parseFloat element.getAttribute(name)
       if _.isNaN value
-        options.default || null
+        if _.isNumber(options.default) then options.default else null
       else
         value
     set: (element, name, val, options) ->

data/lib/assets/javascripts/tao/component.coffee

@@ -136,32 +136,15 @@ TaoComponentBasedOn = (superClassName = 'HTMLElement') ->
       @["_#{_.camelCase name}Changed"]?()
 
     reflow: ->
-      @offsetHeight
+      Tao.helpers.reflow @
       @
 
     beforeCache: ->
       # called before turbolinks cache pages
 
     findComponent: (selectors...) ->
-      readyCallback = selectors.pop() if _.isFunction(_.last(selectors))
-      components = selectors.map (s) =>
-        deferred = $.Deferred()
-        element = @jq.find(s).get(0)
-        if element.connected
-          # make sure element is returned before callback
-          setTimeout -> deferred.resolve()
-        else
-          @on 'tao:connected', s, (e) ->
-            return unless e.target == e.currentTarget
-            deferred.resolve()
-            @off 'tao:connected', s
-        [element, deferred.promise()]
-
-      elements = components.map (c) -> c[0]
-      promises = components.map (c) -> c[1]
-      $.when(promises...).then -> readyCallback?(elements...)
-
-      if elements.length > 1 then elements else elements[0]
+      callback = selectors.pop() if _.isFunction(_.last(selectors))
+      Tao.helpers.findComponent selectors, callback, @
 
     on: (name, args...) ->
       if name && name.indexOf('.') < 0

data/lib/assets/javascripts/tao/helpers.coffee

@@ -3,3 +3,32 @@ Tao.helpers =
 
   reflow: (el) ->
     $(el)[0].offsetHeight
+
+  findComponent: (selectors, callback, scope = document) ->
+    selectors = [selectors] unless _.isArray selectors
+    components = _.flatten selectors.map (s) => $(scope).find(s).get()
+
+    if components.length > 0 && _.isFunction callback
+      Tao.helpers.componentReady components, -> callback(components...)
+
+    if components.length > 1
+      components
+    else if components.length == 1
+      components[0]
+    else
+      null
+
+  componentReady: (components, callback) ->
+    components = [components] unless _.isArray components
+    promises = components.map (el) ->
+      deferred = $.Deferred()
+      if el.connected
+        setTimeout -> deferred.resolve()
+      else
+        el.on 'tao:connected.taoReady', (e) ->
+          return unless e.target == el
+          el.off 'tao:connected.taoReady'
+          deferred.resolve()
+      deferred.promise()
+
+    $.when(promises...).then -> callback()

data/lib/assets/javascripts/tao/index.coffee

@@ -5,8 +5,10 @@
 #= require lodash
 
 #= require_self
+#= require ./helpers
+#= require ./module
+#= require ./component
 #= require ./application
 #= require ./page
-#= require ./helpers
 
 window.Tao = {}

data/lib/generators/tao/install/USAGE

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,12 @@
+#= 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

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

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

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

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

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

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

@@ -0,0 +1,21 @@
+<!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>
+  </body>
+</html>

data/lib/tao_on_rails.rb

@@ -1,4 +1,3 @@
-require 'tao_on_rails/version'
 require 'tao_on_rails/engine'
 
 module TaoOnRails

data/lib/tao_on_rails/action_view/helpers.rb

@@ -1,6 +1,7 @@
 module TaoOnRails
   module ActionView
     module Helpers
+      extend ActiveSupport::Concern
 
       def page_id
         return @page_id if defined?(@page_id)
@@ -8,28 +9,31 @@ module TaoOnRails
         [controller_names, action_name].compact.flatten.join('_').dasherize
       end
 
-      # Define the dynamic view helpers for components
-      # This method should be called in action_view context
-      def self.define_component_helpers
-        load_tao_components
-        ::ActiveSupport.run_load_hooks(:tao_components, self)
+      class_methods do
+        # Define the dynamic view helpers for components
+        # This method should be called in action_view context
+        def define_component_helpers
+          load_tao_components
+          ::ActiveSupport.run_load_hooks(:tao_components, self)
 
-        TaoOnRails::Components::Base.descendants.each do |klass|
-          module_eval %Q{
-            def #{klass.tag_name.underscore} *args, &block
-              #{klass.name}.new(self, *args).render(&block)
-            end
-          }
+          TaoOnRails::Components::Base.descendants.each do |klass|
+            module_eval %Q{
+              def #{klass.tag_name.underscore} *args, &block
+                #{klass.name}.new(self, *args).render(&block)
+              end
+            }
+          end
         end
-      end
 
-      def self.load_tao_components(root = Rails.root)
-        Dir.glob([
-          root.join('lib/components/**/*.rb'),
-          root.join('app/components/**/*.rb')
-        ]).each do |component|
-          require_dependency component
+        def load_tao_components(root = Rails.root)
+          Dir.glob([
+            root.join('lib/**/components/**/*.rb'),
+            root.join('app/**/components/**/*.rb')
+          ]).each do |component|
+            require_dependency component
+          end
         end
+
       end
 
     end

data/lib/tao_on_rails/components/base.rb

@@ -4,12 +4,13 @@ module TaoOnRails
 
       attr_reader :options, :view
 
-      delegate :tag_name, :component_name, :tag_prefix, :template_paths, :template_name, to: :class
+      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[:template_path].present?
+        template_paths.unshift(@options.delete(:template_path)) if @options.key?(:template_path)
+        @tag_name = @options.delete(:tag_name)
       end
 
       def render &block
@@ -47,6 +48,10 @@ module TaoOnRails
         @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

data/lib/tao_on_rails/components/page_component.rb

@@ -1,5 +1,3 @@
-require 'tao_on_rails/components/base'
-
 module TaoOnRails
   module Components
     class PageComponent < Base

data/lib/tao_on_rails/engine.rb

@@ -1,16 +1,17 @@
 require 'turbolinks'
 require 'jquery-rails'
 require 'lodash-rails'
-require 'tao_on_rails/action_view/helpers'
-require 'tao_on_rails/components'
 
 module TaoOnRails
   class Engine < Rails::Engine
 
-    initializer "tao_on_rails.view_helpers" do |app|
+    config.eager_load_paths += Dir["#{config.root}/lib"]
+
+    initializer "tao_on_rails" do
       ::ActiveSupport.on_load :action_view do
-        TaoOnRails::ActionView::Helpers.define_component_helpers
-        include TaoOnRails::ActionView::Helpers
+        include ::TaoOnRails::ActionView::Helpers
+        load_tao_components ::TaoOnRails::Engine.root
+        define_component_helpers
       end
     end
 

data/lib/tao_on_rails/version.rb

@@ -1,3 +1,3 @@
 module TaoOnRails
-  VERSION = "0.9.3"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tao_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.0
 platform: ruby
 authors:
 - Siyuan Liu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-28 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: turbolinks
@@ -181,6 +181,13 @@ files:
 - lib/generators/tao/controller/USAGE
 - lib/generators/tao/controller/controller_generator.rb
 - lib/generators/tao/controller/templates/controller.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/generators/tao/locale/USAGE
 - lib/generators/tao/locale/locale_generator.rb
 - lib/generators/tao/locale/templates/model.yml.erb
@@ -200,7 +207,6 @@ files:
 - lib/generators/tao/view/view_generator.rb
 - lib/tao_on_rails.rb
 - lib/tao_on_rails/action_view/helpers.rb
-- lib/tao_on_rails/components.rb
 - lib/tao_on_rails/components/base.rb
 - lib/tao_on_rails/components/page_component.rb
 - lib/tao_on_rails/engine.rb

data/lib/tao_on_rails/components.rb

@@ -1 +0,0 @@
-require 'tao_on_rails/components/page_component'