clearwater-roda 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5aa8a6d72425620e259a51f9b0bf48d092744bbf
-  data.tar.gz: 11ee3b36747c99c46cdc860e5a92c098bfa47571
+SHA256:
+  metadata.gz: aae557cbde03873eb8060a99e88915cccb430a1a817c812c3a98024b801d7cab
+  data.tar.gz: 363216637b51ae5950d06b4eac92e6ca088ccdd78643db326031e69e0b35345e
 SHA512:
-  metadata.gz: 4a5adf5cc6bb97edc91448ec367d955ddfc61190fdc437b465790146fb9a8f41c2508831663991fa7dbbb06dc684c143f396993fe3bb52dc82ada1aa3c0afea3
-  data.tar.gz: f9df03eba77c6e7af91d069f0fa85731e5c9cc780856befdcac3ec3aa599761d222f35874fb67c3bb6a33a89eeed802076067edfcce53bc77e525165c04352dc
+  metadata.gz: 0451a79d753cca4f54ab27c7a2e8a9eff9e0cfd7148cb2d3ac428b84d6796489ccda7b8738e7470d97d4bddfc13cd84169bb862a8079edd3897ebc367b00d96b
+  data.tar.gz: 53f2260133abd77c39793eadb4497bb02eefeaf2fdeea1d0576b6dd7bc011cbe64a7bb8ab1cd9c0168b73f87149d54137bdf47b69a26d3e167241162950240bb

data/lib/clearwater/roda/application.rb

@@ -7,11 +7,12 @@ module Clearwater
     class Application
       DirectoryAlreadyExists = Class.new(StandardError)
 
+      TEMPLATE_PATH = File.expand_path('../../../../templates', __FILE__)
+
       attr_reader :name
 
       def initialize name
         @name = name
-        @previous_dirs = []
       end
 
       def build
@@ -20,10 +21,7 @@ module Clearwater
         mkdir
         chdir
         write_files
-        bundle
         git_init
-        git_commit
-        chdir_back
 
         puts
         puts <<-EOF
@@ -49,37 +47,21 @@ your assets for production, simply run:
       end
 
       def chdir
-        @previous_dirs.push Dir.pwd
         FileUtils.chdir dir_name
       end
 
-      def chdir_back
-        FileUtils.chdir @previous_dirs.pop
-      end
-
-      def bundle
-        system "bundle -j12"
-      end
-
       def git_init
         `git init`
       end
 
-      def git_commit
-        `git add --all .`
-        `git commit -m 'Hello world!'`
-      end
-
       def write_files
-        files = %W(
-          Gemfile
-          config.ru
-          assets/js/app.rb
-          dev
-          Rakefile
-        )
+        files = Dir["#{TEMPLATE_PATH}/**/*"]
+          .select { |file| File.file? file }
+          .map { |file| file.sub("#{TEMPLATE_PATH}/", '') }
+          .grep_v('app.rb')
         
         files.each do |template_name|
+          puts "Writing #{template_name}..."
           Template.new(
             template_path(template_name),
             template_name,
@@ -88,6 +70,7 @@ your assets for production, simply run:
         end
 
         app_filename = "#{underscore(name)}.rb"
+        puts "Writing #{app_filename}..."
         Template.new(
           template_path('app.rb'),
           app_filename,
@@ -105,7 +88,7 @@ your assets for production, simply run:
       end
 
       def template_path(name)
-        "#{File.expand_path('../../../../templates', __FILE__)}/#{name}"
+        "#{TEMPLATE_PATH}/#{name}"
       end
 
       def underscore name
@@ -113,7 +96,7 @@ your assets for production, simply run:
       end
 
       def titleize name
-        name = name.gsub(/_[a-z]/) { |match| match[1].upcase }
+        name = name.gsub(/[_-][a-z]/) { |match| match[1].upcase }
         name[0] = name[0].upcase
         name
       end

data/lib/clearwater/roda/version.rb

@@ -1,5 +1,5 @@
 module Clearwater
   module Roda
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/templates/Gemfile

@@ -1,11 +1,17 @@
 source 'https://rubygems.org'
 
-gem 'opal'
-gem 'clearwater', '~> 1.0.0.rc4'
 gem 'roda'
 gem 'roda-opal_assets'
+gem 'puma'
+gem 'rake'
 
 group :development do
   gem 'rerun'
-  gem 'rake'
+
+  # Assets from these gems won't be needed in production since they'll be
+  # precompiled
+  gem 'clearwater', '~> 1.0.0.rc4'
+  gem 'grand_central'
+  gem 'grand_central-dev_tools'
+  gem 'clearwater-hot_loader'
 end

data/templates/Rakefile

@@ -1,13 +1,26 @@
-require 'bundler/setup'
+require 'bundler'
+Bundler.setup :default, ENV.fetch('RACK_ENV') { :development }
+$LOAD_PATH << 'app'
+
 require 'opal'
 require 'clearwater'
 require 'roda/opal_assets'
+require 'assets'
 
 # Keep a single asset compiler in case we want to use it for multiple tasks.
 assets = Roda::OpalAssets.new(env: :production)
 
 desc 'Precompile assets for production'
 task 'assets:precompile' do
+  warn = method(:warn)
+  module Kernel
+    def warn(*)
+    end
+  end
   assets << 'app.js'
   assets.build
+
+  Kernel.class_exec do
+    define_method :warn, &warn
+  end
 end

data/templates/app.rb

@@ -1,7 +1,6 @@
 require 'roda'
 require 'roda/opal_assets'
 require 'opal'
-require 'clearwater'
 
 class %{titleized_name} < Roda
   plugin :public
@@ -17,14 +16,26 @@ class %{titleized_name} < Roda
 <html>
   <head>
     <meta charset="utf-8" />
-    <title>%{titleized_name}</title>
+    <title>#{app_title}</title>
   </head>
 
   <body>
     <div id="app"></div>
-    #{assets.js 'app.js'}
+    #{additional_markup}
+    #{assets.js client_app}
   </body>
 </html>
     HTML
   end
+
+  def app_title
+    '%{titleized_name}'
+  end
+
+  def client_app
+    'app.js'
+  end
+
+  def additional_markup
+  end
 end

data/templates/app/assets.rb

@@ -0,0 +1,6 @@
+require 'clearwater'
+require 'grand_central'
+
+# Tools to make development easier
+require 'clearwater/hot_loader'
+require 'grand_central/dev_tools'

data/templates/assets/js/actions.rb

@@ -0,0 +1,36 @@
+require 'grand_central/action'
+
+# Here we define an action taxonomy
+#
+# GrandCentral::Action
+# |
+# + Action -- Your top application-level action
+#   |
+#   + CounterAction
+#   | |
+#   | + Increment
+#   | + Decrement
+#   |
+#   + SetName
+
+# This lets your store handle entire classes of actions with a single check,
+# which is very helpful in large apps with hundreds of actions:
+#
+#   store = GrandCentral::Store.new(initial_state) do |state, action|
+#     case action
+#     when CounterAction
+#       # Handles both Increment and Decrement
+#     when SetName
+#       # ...
+#     else state
+#   end
+
+# Create a top-level action
+Action = GrandCentral::Action.create
+
+CounterAction = Action.create do
+  Increment = create
+  Decrement = create
+end
+
+SetName = Action.with_attributes(:name)

data/templates/assets/js/app.rb

@@ -1,85 +1,9 @@
 require 'opal'
 require 'clearwater'
 
-class Layout
-  include Clearwater::Component
-
-  def render
-    # Equivalent HTML:
-    # <div>
-    #   <h1 class="heading">
-    #     <a href="/">Hello, Clearwater</a>
-    #   </h1>
-    #   <nav>
-    #     <a href="/foo">Foo</a>
-    #     <a href="/bar">Bar</a>
-    #     <a href="/bar/baz">Baz</a>
-    #   </nav>
-    #   <%%= outlet || HomePage.new.render %%>
-    # </div>
-    div([
-      h1({ class_name: 'heading' }, [
-        Link.new({ href: '/' }, 'Hello, Clearwater!'),
-      ]),
-      nav([
-        # The Link component is how you navigate between routes in Clearwater
-        # apps. This leaves the `a` helper method to do a typical hard link.
-        Link.new({ href: '/foo' }, 'Foo'),
-
-        # One of the nice things about defining your UI with code instead of
-        # markup is that adding whitespace doesn't look out of place.
-        ' ',
-        Link.new({ href: '/bar' }, 'Bar'),
-        ' ',
-        Link.new({ href: '/bar/baz' }, 'Baz'),
-      ]),
-
-      # The `outlet` method is a method for routing targets to render their
-      # child routes, similar to the same keyword in Ember.js templates. If
-      # there is no child route, we render a HomePage component.
-      outlet || HomePage.new,
-    ])
-  end
-end
-
-# This is our default homepage component. Note that in the Layout component, we
-# render this by calling HomePage.new. This means we get a brand-new HomePage
-# component each time we render, despite the Layout sticking around for the life
-# of the app. Because of this, our HomePage cannot hold state and only knows
-# about what it is told in its initialize method (which, in this case, is
-# nothing).
-class HomePage
-  include Clearwater::Component
-
-  def render
-    article([
-      h1('Welcome to Clearwater'),
-
-      p(<<-EOP),
-        Clearwater is a Ruby front-end framework.
-      EOP
-    ])
-  end
-end
-
-# We use a Struct here because it's shorthand for a class that takes an argument
-# and gives us an accessor method with that name. Otherwise, it's identical to a
-# typical template; we just wanted to take an argument.
-ChildRoute = Struct.new(:name) do
-  include Clearwater::Component
-
-  def render
-    div([
-      h2(name),
-      p("This is the child route called #{name}"),
-
-      div([
-        h3('Child content:'),
-        outlet,
-      ]),
-    ])
-  end
-end
+require 'store'
+require 'components/layout'
+require 'components/child_route'
 
 router = Clearwater::Router.new do
   # Routing targets are other components. They stick around for the life of the
@@ -123,3 +47,9 @@ app = Clearwater::Application.new(
 # route changes) and triggers the first render. Subsequent renders should use
 # app.render instead.
 app.call
+
+# When actions are dispatched to the store, check to see if they change the
+# state. If so, re-render the app.
+Store.on_dispatch do |before, after, action|
+  app.render unless before.equal?(after)
+end

data/templates/assets/js/components/child_route.rb

@@ -0,0 +1,20 @@
+require 'clearwater/component'
+
+# We use a Struct here because it's shorthand for a class that takes an argument
+# and gives us an accessor method with that name. Otherwise, it's identical to a
+# typical template; we just wanted to take an argument.
+ChildRoute = Struct.new(:name) do
+  include Clearwater::Component
+
+  def render
+    div([
+      h2(name),
+      p("This is the child route called #{name}"),
+
+      div([
+        h3('Child content:'),
+        outlet,
+      ]),
+    ])
+  end
+end

data/templates/assets/js/components/home_page.rb

@@ -0,0 +1,36 @@
+require 'clearwater/component'
+
+require 'store' # Need this for the State module
+require 'actions' # Need to load the actions we want to dispatch
+
+# This is our default homepage component. Note that in the Layout component, we
+# render this by calling HomePage.new. This means we get a brand-new HomePage
+# component each time we render, despite the Layout sticking around for the life
+# of the app. Because of this, our HomePage cannot hold state and only knows
+# about what it is told in its initialize method (which, in this case, is
+# nothing).
+class HomePage
+  include Clearwater::Component
+  include State[:counter, :name] # Add a reader method for attributes in app state
+
+  def render
+    article([
+      h1('Welcome to Clearwater'),
+
+      div([
+        button({ onclick: Decrement }, '-'),
+        counter,
+        button({ onclick: Increment }, '+'),
+      ]),
+
+      div([
+        input(value: name, oninput: SetName),
+        div(name),
+      ]),
+
+      p(<<-EOP),
+        Clearwater is a Ruby front-end framework.
+      EOP
+    ])
+  end
+end

data/templates/assets/js/components/layout.rb

@@ -0,0 +1,44 @@
+require 'clearwater/component'
+
+require 'components/home_page'
+
+class Layout
+  include Clearwater::Component
+
+  def render
+    # Equivalent HTML:
+    # <div>
+    #   <h1 class="heading">
+    #     <a href="/">Hello, Clearwater</a>
+    #   </h1>
+    #   <nav>
+    #     <a href="/foo">Foo</a>
+    #     <a href="/bar">Bar</a>
+    #     <a href="/bar/baz">Baz</a>
+    #   </nav>
+    #   <%%= outlet || HomePage.new.render %%>
+    # </div>
+    div([
+      h1({ class_name: 'heading' }, [
+        Link.new({ href: '/' }, 'Hello, Clearwater!'),
+      ]),
+      nav([
+        # The Link component is how you navigate between routes in Clearwater
+        # apps. This leaves the `a` helper method to do a typical hard link.
+        Link.new({ href: '/foo' }, 'Foo'),
+
+        # One of the nice things about defining your UI with code instead of
+        # markup is that adding whitespace doesn't look out of place.
+        ' ',
+        Link.new({ href: '/bar' }, 'Bar'),
+        ' ',
+        Link.new({ href: '/bar/baz' }, 'Baz'),
+      ]),
+
+      # The `outlet` method is a method for routing targets to render their
+      # child routes, similar to the same keyword in Ember.js templates. If
+      # there is no child route, we render a HomePage component.
+      outlet || HomePage.new,
+    ])
+  end
+end

data/templates/assets/js/dev.rb

@@ -0,0 +1,14 @@
+require 'opal'
+require 'app'
+require 'store'
+
+require 'grand_central/dev_tools'
+require 'clearwater/hot_loader'
+
+dev_tools = GrandCentral::DevTools.new(
+  Store,
+  Bowser.document['#grand-central-dev-tools']
+)
+dev_tools.start
+
+Clearwater::HotLoader.connect 9292

data/templates/assets/js/store.rb

@@ -0,0 +1,62 @@
+require 'grand_central/store'
+require 'grand_central/model'
+
+require 'actions'
+
+class AppState < GrandCentral::Model
+  attributes(
+    :counter,
+    :name,
+  )
+end
+
+initial_state = AppState.new(
+  counter: 0,
+)
+
+Store = GrandCentral::Store.new(initial_state) do |state, action|
+  case action
+  when Increment
+    state.update counter: state.counter + 1
+  when Decrement
+    state.update counter: state.counter - 1
+  when SetName
+    state.update name: action.name
+
+  # If an unknown action was dispatched, we just return the current state.
+  # It is important to return a state object that matches the structure of
+  # the previous one. It becomes the new app state.
+  else
+    state
+  end
+end
+
+# When you want to use application state in a component, you can use this module
+# to add the attribute methods to that component using the following pattern:
+#
+#   class MyCounter
+#     include Clearwater::Component
+#     include State[:counter]
+#
+#     def render
+#       div(counter)
+#     end
+#   end
+module State
+  # If we need to mix the same attributes into two different components, we
+  # can reuse the same mixin.
+  @module_cache = {}
+
+  def self.[](*attrs)
+    @module_cache.fetch(attrs) do
+      @module_cache[attrs] = Module.new do
+        attrs.each do |attr|
+          define_method(attr) { Store.state.send(attr) }
+        end
+      end
+    end
+  end
+end
+
+# Let our actions know where they dispatch to by default
+Action.store = Store

data/templates/config.ru

@@ -1,6 +1,10 @@
-require 'bundler/setup'
+require 'bundler'
+Bundler.setup :default, :production
+
 require './%{underscored_name}'
 
 $LOAD_PATH << 'lib'
 
+use Rack::Deflater
+use Rack::CommonLogger
 run %{titleized_name}

data/templates/dev

@@ -1,5 +1,4 @@
 #!/bin/sh
 
 bundle check || bundle -j12
-
-rerun -i 'assets/**/*' 'rackup'
+bundle exec rerun -i 'assets/**/*' "bundle exec puma dev.ru $*"

data/templates/dev.ru

@@ -0,0 +1,33 @@
+require 'bundler'
+Bundler.setup :default, :development
+$LOAD_PATH << 'app'
+require 'assets'
+
+require './%{underscored_name}'
+
+Clearwater::HotLoader.start
+
+class %{titleized_name}Dev < %{titleized_name}
+  route do |r|
+    r.on('clearwater_hot_loader') { r.run Clearwater::HotLoader }
+
+    instance_exec(r, &self.class.superclass.route_block)
+  end
+
+  def app_title
+    '%{titleized_name} [DEV]'
+  end
+
+  def client_app
+    'dev'
+  end
+
+  def additional_markup
+    <<~HTML
+      <div id="grand-central-dev-tools"></div>
+    HTML
+  end
+end
+
+use Rack::CommonLogger
+run %{titleized_name}Dev

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clearwater-roda
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jamie Gaskins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2017-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,9 +78,17 @@ files:
 - templates/Gemfile
 - templates/Rakefile
 - templates/app.rb
+- templates/app/assets.rb
+- templates/assets/js/actions.rb
 - templates/assets/js/app.rb
+- templates/assets/js/components/child_route.rb
+- templates/assets/js/components/home_page.rb
+- templates/assets/js/components/layout.rb
+- templates/assets/js/dev.rb
+- templates/assets/js/store.rb
 - templates/config.ru
 - templates/dev
+- templates/dev.ru
 homepage: https://github.com/clearwater-rb/clearwater-roda
 licenses: []
 metadata: {}
@@ -100,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Generate a Roda/Clearwater app from scratch