reactrb-rails-generator 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b0bf20d67944415396dd2058f4ecca1e12e4568
+  data.tar.gz: 5f64d143a2c040cc454bf97eb27d7420411948bc
+SHA512:
+  metadata.gz: aa0ad96979e6db5740a2d713b92b3637eab1ad0261fa700563d98bbd43870dbfb7a252ab2c830277b763c6c0d7c73061c23e8c1f0abe617ccbb047a41bec05a7
+  data.tar.gz: 8243ade5a8a86c74ded42d21e6434aca58c4d4e945a180ead79eb6c8d84cb3df32d51b50c2f518a6f8e8665555ceeb395f8e0c66419cb6770a5c5484df6929e3

data/lib/generators/reactrb/component_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+module Reactrb
+  class Component < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :components, type: :array
+    def create_component_file
+      self.components.each do |component|
+        component_array = component.split('::')
+        @modules = component_array[0..-2]
+        @file_name = component_array.last
+        @indet = 1
+        template 'component_template.rb',
+                 File.join('app/views/components',
+                           @modules.map(&:downcase).join('/'),
+                           "#{@file_name.underscore}.rb")
+      end
+    end
+  end
+end

data/lib/generators/reactrb/install_generator.rb

@@ -0,0 +1,94 @@
+require 'rails/generators'
+module Reactrb
+  class InstallGenerator < Rails::Generators::Base
+    class_option :'reactive-record', type: :boolean
+    class_option :'opal-jquery', type: :boolean
+    class_option :'reactrb-router', type: :boolean
+    class_option :all, type: :boolean
+
+    def inject_react_file_js
+      inject_into_file 'app/assets/javascripts/application.js',
+                       after: "// about supported directives.\n" do
+        <<-'JS'
+//= require 'components'
+//= require 'react_ujs'
+        JS
+      end
+      inject_into_file 'app/assets/javascripts/application.js',
+                       after: "//= require jquery_ujs\n" do
+        <<-'JS'
+Opal.load('components');
+        JS
+      end
+    end
+
+    def inject_engine_to_routes
+      if options[:'reactive-record'] || options[:all]
+        route 'mount ReactiveRecord::Engine => \'/rr\''
+      end
+    end
+
+    def create_components_directory
+      create_file 'app/views/components/.keep', ''
+      if options[:'reactive-record'] || options[:all]
+        create_file 'app/models/public/.keep', ''
+      end
+    end
+
+    def create_manifests
+      create_file 'app/views/components.rb', <<-FILE
+# app/views/components.rb
+require 'opal'
+require 'react'
+require 'reactrb'
+if React::IsomorphicHelpers.on_opal_client?
+  require 'opal-jquery'
+  require 'browser'
+  require 'browser/interval'
+  require 'browser/delay'
+  # add any additional requires that can ONLY run on client here
+end
+#{"require 'reactrb-router'\nrequire 'react_router'" if options[:'reactive-router'] || options[:all]}
+#{'require \'reactive-record\'' if options[:'reactive-record'] || options[:all]}
+#{'require \'models\''          if options[:'reactive-record'] || options[:all]}
+require_tree './components'
+      FILE
+
+      if options[:'reactive-record'] || options[:all]
+        create_file 'app/models/models.rb', <<-FILE
+# app/models/models.rb
+require_tree './public'
+        FILE
+      end
+    end
+
+    def add_config
+      application 'config.assets.paths << ::Rails.root.join(\'app\', \'models\').to_s'
+      application 'config.autoload_paths += %W(#{config.root}/app/views/components)'
+      if options[:'reactive-record'] || options[:all]
+        application 'config.autoload_paths += %W(#{config.root}/app/models/public)'
+      end
+      application 'config.eager_load_paths += %W(#{config.root}/app/views/components)'
+      if options[:'reactive-record'] || options[:all]
+        application 'config.eager_load_paths += %W(#{config.root}/app/models/public)'
+      end
+      application 'config.watchable_files.concat Dir["#{config.root}/app/views/**/*.rb"]',
+                  env: :development
+      application 'config.react.variant = :development', env: :development
+    end
+
+    def add_gems
+      gem 'reactrb'
+      gem 'react-rails', '>= 1.3.0'
+      gem 'opal-rails', '>= 0.8.1'
+      gem 'therubyracer', platforms: :ruby
+
+      # optional gems
+      if options[:'reactrb-router'] || options[:all]
+        gem 'react-router-rails', '~> 0.13.3'
+        gem 'reactrb-router'
+      end
+      gem 'reactive-record', '>= 0.8.0' if options[:'reactive-record'] || options[:all]
+    end
+  end
+end

data/lib/generators/reactrb/router_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+module Reactrb
+  class Router < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    argument :components, type: :array
+    def create_component_file
+      self.components.each do |component|
+        component_array = component.split('::')
+        @modules = component_array[0..-2]
+        @file_name = component_array.last
+        @indet = 1
+        template 'router_template.rb',
+                 File.join('app/views/components',
+                           @modules.map(&:downcase).join('/'),
+                           "#{@file_name.underscore}.rb")
+      end
+    end
+  end
+end

data/lib/generators/reactrb/templates/component_template.rb

@@ -0,0 +1,41 @@
+module Components
+  <%- @modules.each do |module_name| %><%= "  "* @indet %>module <%= module_name.camelize %><%- @indet += 1 %>
+  <%- end %><%="  "* @indet %>class <%= @file_name %> < React::Component::Base
+
+  <%="  "* @indet %># param :my_param
+  <%="  "* @indet %># param param_with_default: "default value"
+  <%="  "* @indet %># param :param_with_default2, default: "default value" # alternative syntax
+  <%="  "* @indet %># param :param_with_type, type: Hash
+  <%="  "* @indet %># param :array_of_hashes, type: [Hash]
+  <%="  "* @indet %># collect_all_other_params_as :attributes  #collects all other params into a hash
+
+  <%="  "* @indet %># The following are the most common lifecycle call backs,
+  <%="  "* @indet %># the following are the most common lifecycle call backs# delete any that you are not using.
+  <%="  "* @indet %># call backs may also reference an instance method i.e. before_mount :my_method
+
+  <%="  "* @indet %>before_mount do
+  <%="  "* @indet %>  # any initialization particularly of state variables goes here.
+  <%="  "* @indet %>  # this will execute on server (prerendering) and client.
+  <%="  "* @indet %>end
+
+  <%="  "* @indet %>after_mount do
+  <%="  "* @indet %>  # any client only post rendering initialization goes here.
+  <%="  "* @indet %>  # i.e. start timers, HTTP requests, and low level jquery operations etc.
+  <%="  "* @indet %>end
+
+  <%="  "* @indet %>before_update do
+  <%="  "* @indet %>  # called whenever a component will be re-rerendered
+  <%="  "* @indet %>end
+
+  <%="  "* @indet %>before_unmount do
+  <%="  "* @indet %>  # cleanup any thing (i.e. timers) before component is destroyed
+  <%="  "* @indet %>end
+
+  <%="  "* @indet %>def render
+  <%="  "* @indet %>  div do
+  <%="  "* @indet %>    "<%= (@modules+[@file_name]).join('::') %>"
+  <%="  "* @indet %>  end
+  <%="  "* @indet %>end
+<%="  "* @indet %>end
+  <%- @modules.each do %><%- @indet -= 1 %><%="  "* @indet %>end
+  <%- end %>end

data/lib/generators/reactrb/templates/router_template.rb

@@ -0,0 +1,44 @@
+module Components
+  <%- @modules.each do |module_name| %><%= "  "* @indet %>module <%= module_name.camelize %><%- @indet += 1 %>
+  <%- end %><%="  "* @indet %>class <%= @file_name %>
+
+  <%="  "* @indet %>include React::Router
+
+  <%="  "* @indet %>routes(path: "/") do  # change path to be the base path
+  <%="  "* @indet %>  # you will probably want to update your config/routes.rb file so that it matches all
+  <%="  "* @indet %>  # subroutes: i.e. get '(*subroutes)' => "<%= (@modules.last || 'home').underscore %>#<%= @file_name.underscore %>"
+  <%="  "* @indet %>  # basic route has:
+  <%="  "* @indet %>  #   a path
+  <%="  "* @indet %>  #   a name - used to reference the route in methods like redirect, and link)
+  <%="  "* @indet %>  #   a handler - the component that will be mounted on this route
+  <%="  "* @indet %>  route(path: "subroute1-path", name: :subroute1, handler: Subroute1Component)
+  <%="  "* @indet %>  route(path: "subroute2-path", name: :subroute2, handler: Subroute2Component)
+  <%="  "* @indet %>  # routes can take parameters designated with a colon:
+  <%="  "* @indet %>  route(path: "subroute3-path/:user_id", name: subroute3, handler: Subroute3Component)
+  <%="  "* @indet %>  # the redirect method will transition any incoming matching routes to a new route
+  <%="  "* @indet %>  redirect(from: "/", to: :subroute1)
+  <%="  "* @indet %>  # the not_found method indicates which component to load if no route matches:
+  <%="  "* @indet %>  not_found(handler: NotFound)
+  <%="  "* @indet %>end
+
+  <%="  "* @indet %>router_param :user_id, as: :user do |id|
+  <%="  "* @indet %>  # Translate incoming route params to internal values.
+  <%="  "* @indet %>  # In this case we will refer to the translated user_id as user.
+  <%="  "* @indet %>  # The block param (id) will have the value of the param.
+  <%="  "* @indet %>  # This is useful for looking up ActiveRecord models by ids, etc.
+  <%="  "* @indet %>end
+
+  <%="  "* @indet %>def show # note that the top level router has a show method NOT render
+  <%="  "* @indet %>  div do
+  <%="  "* @indet %>    #    content to display on every route
+  <%="  "* @indet %>    # link generates an anchor tag.
+  <%="  "* @indet %>    link(to: :subroute3, params: {user_id: 12}, class: "link-class") { "Click to go to subroute3" }
+  <%="  "* @indet %>    # within an event handler use transition_to to move to a new route
+  <%="  "* @indet %>    # the route_handler method will display the current route, it can be called in the
+  <%="  "* @indet %>    # router, or in some child component.
+  <%="  "* @indet %>    route_handler
+  <%="  "* @indet %>  end
+  <%="  "* @indet %>end
+<%="  "* @indet %>end
+  <%- @modules.each do %><%- @indet -= 1 %><%="  "* @indet %>end
+  <%- end %>end

data/lib/reactrb-rails-generator.rb

@@ -0,0 +1,4 @@
+require 'rails/generators'
+require 'generators/reactrb/install_generator'
+require 'generators/reactrb/component_generator'
+require 'generators/reactrb/router_generator'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: reactrb-rails-generator
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Loic Boutet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: This gem provide rails generators for reactrb
+email: loic@boutet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/reactrb/component_generator.rb
+- lib/generators/reactrb/install_generator.rb
+- lib/generators/reactrb/router_generator.rb
+- lib/generators/reactrb/templates/component_template.rb
+- lib/generators/reactrb/templates/router_template.rb
+- lib/reactrb-rails-generator.rb
+homepage: https://github.com/reactrb/reactrb-rails-generator
+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: Reactrb generators for rails
+test_files: []