tao_on_rails 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18cf70d94e5c971dd3bcf9b0525b324767d55ca7
-  data.tar.gz: 5ef69465b21078177c69d852bcf0048fdaf8bf3e
+  metadata.gz: f3c6267c2913b2dde1120969bb3d9aaf31fbd44a
+  data.tar.gz: 348f07e5e6b7ae5bf850e2f1739cbe2c10939045
 SHA512:
-  metadata.gz: 16683209053ac132c3d22382a82a511aa63c43193e00631206259ee5b8ce7e4744d8e40f2798fa072c960490c77d2715bd813e10d7e6bdd9b660e22c4d7dd926
-  data.tar.gz: 1139cd527ef3638a08fe967ac1a67799d99aa21d945d7b40b6600214d5720e325fe0888a9950991b0d8f18e5b83a0a2059fc8e60f156715c25287ac0f2ec2e52
+  metadata.gz: 2b2ca6b983f5edbbaa9485f758226393ad1a0381cf571ba7c822d57f586531a630f6420ff91edaefcbcbfafe642ecec8f15701fef4de36953bb6b1c8fbdb9b06
+  data.tar.gz: 6fea03e197c664e99f21dc59dae336c69851c1b5eb33bb518b6671c440cf57e1dc578f6d0312ef5ef9a23b035433214025dcd3d509c5ccdd662f78667aec01dc

data/README.md

@@ -1,26 +1,33 @@
 # 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 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.
+[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.
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Create new Tao on Rails application with following commands:
 
-```ruby
-gem 'tao_on_rails'
+```bash
+rails new app_name -m https://git.io/vM1lZ
 ```
 
-And then execute:
+Several generators are available for you to quickly start your work:
 
-    $ bundle
+* tao:assets
+* tao:view
+* tao:controller
+* tao:locale
+* tao:channel
+* tao:scaffold
 
-Or install it yourself as:
+It is recommended to use `tao:scaffold` generator as first step of your workflow. See `rails g tao:scaffold --help` for more information.
 
-    $ gem install tao_on_rails
+## Plugin
 
-## Usage
+Start writing plugin for Tao on Rails with following commands:
 
-TODO: Write usage instructions here.
+```bash
+rails plugin new plugin_name -m https://git.io/vM1lE
+```
 
 ## Contributing
 

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.pattern = 'test/**/*_test.rb'
 end
 
 task :default => :test

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

@@ -2,7 +2,7 @@
 
 class TaoPage extends TaoComponent
 
-  @attribute 'layout'
+  @attribute 'layout', default: 'default'
 
   beforeCache: ->
     @jp.find('[tao-id]').each (i, el) =>

data/lib/generators/tao/assets/USAGE

@@ -0,0 +1,18 @@
+Description:
+    Generate assets files for tao page.
+
+Example:
+    `rails generate tao:assets employee index`
+
+    Create files:
+        app/assets/javascripts/employees/index_page.coffee
+        app/assets/stylesheets/employees/index_page.scss
+
+
+    `rails generate tao:assets home index --variants=default phone`
+
+    Create files:
+        app/assets/javascripts/default/employees/index_page.coffee
+        app/assets/stylesheets/default/employees/index_page.scss
+        app/assets/javascripts/phone/employees/index_page.coffee
+        app/assets/stylesheets/phone/employees/index_page.scss

data/lib/generators/tao/assets/assets_generator.rb

@@ -0,0 +1,8 @@
+module Tao
+  module Generators
+    class AssetsGenerator < ::Rails::Generators::NamedBase
+      hook_for "coffee", in: :tao, type: :boolean, default: true
+      hook_for "sass", in: :tao, type: :boolean, default: true
+    end
+  end
+end

data/lib/generators/tao/channel/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generate channel files for action cable.
+
+Example:
+    `rails generate tao:channel chat speak`
+
+    Create files:
+        app/assets/javascripts/channels/chat.coffee
+        app/channels/chat_channel.rb

data/lib/generators/tao/channel/channel_generator.rb

@@ -0,0 +1,17 @@
+module Tao
+  module Generators
+    class ChannelGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :actions, type: :array, default: [], banner: "method method"
+
+      check_class_collision suffix: "Channel"
+
+      def create_channel_files
+        template "channel.coffee.erb", "app/assets/javascripts/channels/#{name.singularize}.coffee"
+        template "channel.rb.erb", "app/channels/#{name.singularize}_channel.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/tao/channel/templates/channel.coffee.erb

@@ -0,0 +1,20 @@
+app.<%= class_name.camelize(:lower) %>Channel = app.cable.subscriptions.create "<%= class_name %>Channel",
+  connected: ->
+    # Called when the subscription is ready for use on the server
+    if app.currentPage
+      currentPage.trigger 'channel-connected', ['<%= class_name.underscore %>']
+
+  disconnected: ->
+    # Called when the subscription has been terminated by the server
+    if app.currentPage
+      currentPage.trigger 'channel-disconnected', ['<%= class_name.underscore %>']
+
+  received: (data) ->
+    # Called when there's incoming data on the websocket for this channel
+    if app.currentPage
+      currentPage.trigger 'channel-received', ['<%= class_name.underscore %>', data]
+<% actions.each do |action| -%>
+
+  <%= action %>: ->
+    @perform '<%= action %>'
+<% end -%>

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

@@ -0,0 +1,13 @@
+class <%= class_name %>Channel < ApplicationCable::Channel
+  def subscribed
+    # stream_from "some_channel"
+  end
+
+  def unsubscribed
+    # Any cleanup needed when channel is unsubscribed
+  end
+<% actions.each do |action| -%>
+  def <%= action %>
+  end
+<% end -%>
+end

data/lib/generators/tao/coffee/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Generate coffee files for tao page.
+
+Example:
+    `rails generate tao:coffee employee new`
+
+    Create coffee file:
+        app/assets/javascripts/employees/new.coffee
+
+
+    `rails generate tao:coffee employee index --variants=default phone`
+
+    Create coffee files:
+        app/assets/javascripts/default/employees/index.coffee
+        app/assets/javascripts/phone/employees/index.coffee

data/lib/generators/tao/coffee/coffee_generator.rb

@@ -0,0 +1,27 @@
+module Tao
+  module Generators
+    class CoffeeGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :actions, type: :array, default: %w(index new edit show), banner: "new edit"
+
+      class_option :variants, type: :array, default: [], desc: "Generate assets for different variants"
+
+      attr_reader :page_id
+
+      def create_coffee_file
+        actions.each do |action|
+          @page_id = [class_path, file_name, action].flatten.join('-')
+          if (variants = options[:variants]).any?
+            variants.each do |variant|
+              template "coffee.erb", File.join("app/assets/javascripts", variant, name.pluralize, "#{action}_page.coffee")
+            end
+          else
+            template "coffee.erb", File.join('app/assets/javascripts', name.pluralize, "#{action}_page.coffee")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/tao/coffee/templates/coffee.erb

@@ -0,0 +1,14 @@
+class <%= page_id.underscore.camelize %>Page extends TaoPage
+
+  @tag: "<%= page_id %>-page"
+
+  _init: ->
+    # called when the page connected to dom for the first time
+
+  _connected: ->
+    # called every time the page connected to dom
+
+  _disconnected: ->
+    # called every time the page disconnected from dom
+
+TaoPage.register <%= page_id.underscore.camelize %>Page

data/lib/generators/tao/controller/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate controller files
+
+Example:
+    `rails generate tao:controller home index`
+
+    Create file:
+        app/controllers/home_controller.rb

data/lib/generators/tao/controller/controller_generator.rb

@@ -0,0 +1,20 @@
+module Tao
+  module Generators
+
+    class ControllerGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :actions, type: :array, default: %w(index new create edit update show destroy), banner: "action action"
+
+      check_class_collision suffix: "Controller"
+
+      attr_reader :resource
+
+      def create_controller_file
+        @resource = file_name.singularize
+        template "controller.rb.erb", File.join('app/controllers', class_path, "#{file_name}_controller.rb")
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+class <%= class_name %>Controller < ApplicationController
+  <% if "new".in? actions %>
+  def new
+    build_<%= resource %>
+  end
+  <% end -%>
+  <% if "create".in? actions %>
+  def create
+    build_<%= resource %>
+    @<%= resource %>.save
+  end
+  <% end -%>
+  <% if "edit".in? actions %>
+  def edit
+    load_<%= resource %>
+    build_<%= resource %>
+  end
+  <% end -%>
+  <% if "update".in? actions %>
+  def update
+    load_<%= resource %>
+    build_<%= resource %>
+    @<%= resource %>.save
+  end
+  <% end -%>
+  <% if "show".in? actions %>
+  def show
+    load_<%= resource %>
+  end
+  <% end -%>
+  <% if "destroy".in? actions %>
+  def destroy
+    load_<%= resource %>
+    @<%= resource %>.destroy
+  end
+  <% end -%>
+  <% unless actions.empty? %>
+  private
+  <% end -%>
+  <% unless actions == %w(destroy) %>
+  def build_<%= resource %>
+    @<%= resource %> ||= <%= class_name %>.new
+    @<%= resource %>.attributes = <%= resource %>_params
+  end
+  <% end -%>
+  <% if (actions & %w(edit update show destroy)).any? %>
+  def load_<%= resource %>
+    @<%= resource %> = <%= class_name %>.find params[:id]
+  end
+  <% end -%>
+  <% unless actions == %w(destroy) %>
+  def <%= resource %>_params
+    params.fetch(:<%= singular_table_name %>, {}).permit()
+  end
+  <% end -%>
+
+end

data/lib/generators/tao/locale/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Generate locale files
+
+Example:
+    `rails generate tao:locale namespace/resource zh-CN en`
+
+    Create files:
+        config/locales/models/namespace/resource/zh-CN.yml
+        config/locales/models/namespace/resource/en.yml
+        config/locales/views/namespace/resources/zh-CN.yml
+        config/locales/views/namespace/resources/en.yml

data/lib/generators/tao/locale/locale_generator.rb

@@ -0,0 +1,34 @@
+module Tao
+  module Generators
+    class LocaleGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :locales, type: :array, default: [I18n.locale], banner: "locale locale"
+
+      class_option :model, type: :boolean, default: true, desc: "Generate locale files for model"
+      class_option :view, type: :boolean, default: true, desc: "Generate locale files for view"
+
+      attr_reader :locale
+
+      def copy_to_model
+        return unless options[:model]
+        locales.each do |locale|
+          @locale = locale
+          template "model.yml.erb", File.join('config/locales/models', name.pluralize, "#{locale}.yml")
+        end
+      end
+
+      def copy_to_view
+        return unless options[:view]
+        file_content = (class_path + [plural_name]).reverse.inject(nil) do |content, path|
+          { path => content }
+        end
+        locales.each do |locale|
+          @locale = locale
+          create_file File.join('config/locales/views', name.pluralize, "#{locale}.yml"), {locale => file_content}.to_yaml
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/tao/locale/templates/model.yml.erb

@@ -0,0 +1,7 @@
+<%= locale %>:
+  activerecord:
+    models:
+      <%= template_namespace = class_path.map(&:pluralize).join('/') %>/<%= template_name = singular_name.singularize %>: <%= template_name.capitalize %>
+    attributes:
+      <%= template_namespace %>/<%= template_name %>:
+        # attributes

data/lib/generators/tao/sass/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Generate sass files for tao page.
+
+Example:
+    `rails generate tao:sass employee new`
+
+    Create coffee file:
+        app/assets/stylesheets/employees/new.coffee
+
+
+    `rails generate tao:sass employee index --variants=default phone`
+
+    Create coffee files:
+        app/assets/stylesheets/default/employees/index.coffee
+        app/assets/stylesheets/phone/employees/index.coffee

data/lib/generators/tao/sass/sass_generator.rb

@@ -0,0 +1,27 @@
+module Tao
+  module Generators
+    class SassGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :actions, type: :array, default: %w(index new edit show), banner: "action action"
+
+      class_option :variants, type: :array, default: [], desc: "Generate assets for different variants"
+
+      attr_reader :page_id
+
+      def create_sass_file
+        actions.each do |action|
+          @page_id = [class_path, file_name, action].flatten.join('-')
+          if (variants = options[:variants]).any?
+            variants.each do |variant|
+              template "sass.erb", File.join("app/assets/stylesheets", variant, name.pluralize, "#{action}_page.scss")
+            end
+          else
+            template "sass.erb", File.join('app/assets/stylesheets', name.pluralize, "#{action}_page.scss")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/tao/sass/templates/sass.erb

@@ -0,0 +1,3 @@
+<%= page_id.dasherize %>-page {
+  
+}

data/lib/generators/tao/scaffold/USAGE

@@ -0,0 +1,22 @@
+Description:
+    Scaffolds all files in the workflow of tao.
+
+Example:
+    `rails generate tao:scaffold employees/salary index show --channel --locale`
+
+    Create files:
+        app/assets/javascripts/employees/salaries/index_page.coffee
+        app/assets/javascripts/employees/salaries/show_page.coffee
+        app/assets/stylesheets/employees/salaries/index_page.scss
+        app/assets/stylesheets/employees/salaries/show_page.scss
+
+        app/views/employees/salaries/index.html.erb
+        app/views/employees/salaries/show.html.coffee
+
+        app/controllers/employees/salaries_conroller.rb
+
+        app/assets/javascripts/channels/employees/salary.coffee
+        app/channels/employees/salary_channel.rb
+
+        config/locales/models/employees/salaries/en.yml
+        config/locales/views/employees/salaries/en.yml

data/lib/generators/tao/scaffold/scaffold_generator.rb

@@ -0,0 +1,16 @@
+module Tao
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+
+      argument :actions, type: :array, default: %w(index new create edit update show destroy), banner: "action action"
+
+      hook_for 'view', in: :tao, type: :boolean, default: true
+      hook_for 'controller', in: :tao, type: :boolean, default: true
+      hook_for 'assets', in: :tao, type: :boolean, default: true
+
+      hook_for 'locale', in: :tao, type: :array do |instance, locale|
+        instance.invoke 'tao:locale', [instance.name] << locale
+      end
+    end
+  end
+end

data/lib/generators/tao/view/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generate view files for tao page
+
+Example:
+    rails generate tao:view options/grant new create
+
+    This will create:
+        app/views/options/grants/new.html.erb
+        app/views/options/grants/create.js.coffee

data/lib/generators/tao/view/templates/create.js.coffee

@@ -0,0 +1,5 @@
+<%% if @<%= @resource %>.errors.any? %>
+  # handle errors
+<%% else %>
+  # perform create actions
+<%% end %>

data/lib/generators/tao/view/templates/destroy.js.coffee

@@ -0,0 +1,2 @@
+$("#<%%= dom_id(@<%= @resource %>) %>").fadeOut ->
+  $(this).remove()

data/lib/generators/tao/view/templates/edit.html.erb

@@ -0,0 +1 @@
+<%%= @<%= @resource %>.inspect %>

data/lib/generators/tao/view/templates/index.html.erb

@@ -0,0 +1 @@
+<%%= @<%= @resource.pluralize %>.inspect %>

data/lib/generators/tao/view/templates/new.html.erb

@@ -0,0 +1 @@
+<%%= @<%= @resource %>.inspect %>

data/lib/generators/tao/view/templates/show.html.erb

@@ -0,0 +1 @@
+<%%= @<%= @resource %>.inspect %>

data/lib/generators/tao/view/templates/update.js.coffee

@@ -0,0 +1,5 @@
+<%% if @<%= @resource %>.errors.any? %>
+  # handle errors
+<%% else %>
+  # perform update actions
+<%% end %>

data/lib/generators/tao/view/view_generator.rb

@@ -0,0 +1,38 @@
+module Tao
+  module Generators
+    class ViewGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :actions, type: :array, default: %w(index show new create edit update destroy), banner: "action action"
+
+      class_option :variants, type: :array, default: [], desc: "Generate assets for different variants"
+
+      attr_reader :resource
+
+      def create_view_files
+        @resource = file_name.singularize
+        view_path = Pathname.new(File.join("app/views", name.pluralize))
+
+        actions.each do |action|
+          if (variants = options[:variants]).any?
+            variants.each do |variant|
+              variant = variant == 'default' ? '' : "+#{variant}"
+              if action.in? %w(create update destroy)
+                template "#{action}.js.coffee", view_path.join("#{action}.js#{variant}.coffee")
+              else
+                template "#{action}.html.erb", view_path.join("#{action}.html#{variant}.erb")
+              end
+            end
+          else
+            if action.in? %w(create update destroy)
+              template "#{action}.js.coffee", view_path.join("#{action}.js.coffee")
+            else
+              template "#{action}.html.erb", view_path.join("#{action}.html.erb")
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/tao_on_rails/{rails/engine.rb → engine.rb}

@@ -3,8 +3,7 @@ require 'jquery-rails'
 require 'lodash-rails'
 
 module TaoOnRails
-  module Rails
-    class Engine < ::Rails::Engine
-    end
+  class Engine < Rails::Engine
+
   end
 end

data/lib/tao_on_rails/version.rb

@@ -0,0 +1,3 @@
+module TaoOnRails
+  VERSION = "0.6.2"
+end

data/lib/tao_on_rails.rb

@@ -1,7 +1,5 @@
-require "tao_on_rails/rails"
+require 'tao_on_rails/version'
+require 'tao_on_rails/engine'
 
 module TaoOnRails
-  def self.root
-    File.dirname __dir__
-  end
 end

data/lib/tasks/{tao_icons.rake → icons.rake}

@@ -1,7 +1,7 @@
 namespace :tao do
 
   desc 'generate svg icons.'
-  task :generate_icons => :environment do
+  task :icons => :environment do
     dir_name = "#{Rails.root}/vendor/assets/javascripts/tao"
     Dir.mkdir(dir_name) unless File.exists?(dir_name)
 

data/lib/templates/app/app_template.rb

@@ -0,0 +1,60 @@
+require "shellwords"
+
+def apply_template!
+  assert_rails_version
+  assert_options
+  add_template_dir_to_source_paths
+
+  gem 'tao_on_rails', github: 'mycolorway/tao_on_rails', branch: 'refactor-structure'
+
+  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/javascripts/home/index_page.coffee'
+  template 'app/assets/stylesheets/home/index_page.scss'
+
+  template 'app/views/layouts/application.html.erb', force: true
+  template 'app/helpers/application_helper.rb', force: true
+  template 'app/views/home/index.html.erb'
+
+  template 'app/controllers/home_controller.rb'
+  route "root to: 'home#index'"
+end
+
+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 #{RAILS_REQUIREMENT} is required'
+end
+
+def assert_options
+  valid_options = {
+    :skip_gemfile => false,
+    :skip_bundle => false
+  }
+  valid_options.each do |key, expected|
+    next unless options.key?(key)
+    actual = options[key]
+    if actual != expected
+      fail Rails::Generators::Error, "Unsupported option: #{key}=#{actual}"
+    end
+  end
+end
+
+def add_template_dir_to_source_paths
+  if __FILE__ =~ %r{\Ahttps?://}
+    tmp_dir = Dir.mktmpdir('_tao_template')
+    at_exit { remove_dir tmp_dir }
+    repo_url = 'https://github.com/mycolorway/tao_on_rails.git'
+    git :clone => "--quiet --depth 1 #{repo_url} #{tmp_dir}".shellescape
+    source_paths.unshift File.expand_path('lib/templates/app/templates', tmp_dir)
+  else
+    source_paths.unshift(File.expand_path('../templates', __FILE__))
+  end
+end
+
+apply_template!