clearwater-roda 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5aa8a6d72425620e259a51f9b0bf48d092744bbf
+  data.tar.gz: 11ee3b36747c99c46cdc860e5a92c098bfa47571
+SHA512:
+  metadata.gz: 4a5adf5cc6bb97edc91448ec367d955ddfc61190fdc437b465790146fb9a8f41c2508831663991fa7dbbb06dc684c143f396993fe3bb52dc82ada1aa3c0afea3
+  data.tar.gz: f9df03eba77c6e7af91d069f0fa85731e5c9cc780856befdcac3ec3aa599761d222f35874fb67c3bb6a33a89eeed802076067edfcce53bc77e525165c04352dc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jgaskins@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clearwater-roda.gemspec
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+# Clearwater::Roda
+
+This gem helps you generate a Clearwater/Roda app from scratch.
+
+## Installation
+
+    $ gem install clearwater-roda
+
+## Usage
+
+    $ clearwater-roda new my_app
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it
+1. Branch it
+1. Hack it
+1. Save it
+1. Commit it
+1. Push it
+1. Pull-request it
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/clearwater-rb/clearwater-roda. 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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clearwater/roda"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/clearwater-roda.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clearwater/roda/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clearwater-roda"
+  spec.version       = Clearwater::Roda::VERSION
+  spec.authors       = ["Jamie Gaskins"]
+  spec.email         = ["jgaskins@gmail.com"]
+
+  spec.summary       = %q{Generate a Roda/Clearwater app from scratch}
+  spec.homepage      = "https://github.com/clearwater-rb/clearwater-roda"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/exe/clearwater-roda

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'clearwater/roda'
+
+# If this grows beyond this simple app generator, may want to use something like
+# Thor. But for now, this is all we really need.
+
+command, app_name, _ = ARGV
+
+usage = <<-USAGE
+Usage:
+  $ clearwater-roda new APP_NAME'
+    # Generates a Clearwater/Roda app with the specified name.
+  $ clearwater-roda -v'
+    # Display version and exit
+  $ clearwater-roda -h'
+    # Display usage info
+USAGE
+
+case command
+when 'new'
+  Clearwater::Roda.build_app app_name
+when '-v'
+  puts Clearwater::Roda::VERSION
+when '-h'
+  puts usage
+else
+  warn usage
+  exit 1
+end

data/lib/clearwater/roda/application.rb

@@ -0,0 +1,136 @@
+require 'fileutils'
+
+require 'clearwater/roda/template'
+
+module Clearwater
+  module Roda
+    class Application
+      DirectoryAlreadyExists = Class.new(StandardError)
+
+      attr_reader :name
+
+      def initialize name
+        @name = name
+        @previous_dirs = []
+      end
+
+      def build
+        dir_must_not_exist!
+
+        mkdir
+        chdir
+        write_files
+        bundle
+        git_init
+        git_commit
+        chdir_back
+
+        puts
+        puts <<-EOF
+Thanks for using Clearwater::Roda!
+
+To run your new app:
+
+    $ cd #{dir_name}
+    $ ./dev
+
+Then point your browser to http://localhost:9292/
+
+The Clearwater app lives in #{Dir.pwd}/#{dir_name}/assets/js/app.rb. To compile
+your assets for production, simply run:
+
+    $ rake assets:precompile
+
+        EOF
+      end
+
+      def mkdir
+        FileUtils.mkdir_p dir_name
+      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.each do |template_name|
+          Template.new(
+            template_path(template_name),
+            template_name,
+            template_options,
+          ).write
+        end
+
+        app_filename = "#{underscore(name)}.rb"
+        Template.new(
+          template_path('app.rb'),
+          app_filename,
+          template_options,
+        ).write
+
+        FileUtils.chmod 0744, 'dev'
+      end
+
+      def template_options
+        {
+          underscored_name: dir_name,
+          titleized_name: class_name,
+        }
+      end
+
+      def template_path(name)
+        "#{File.expand_path('../../../../templates', __FILE__)}/#{name}"
+      end
+
+      def underscore name
+        name.gsub(/\w[A-Z]/) { |match| "#{match[0]}_#{match[1]}" }.downcase
+      end
+
+      def titleize name
+        name = name.gsub(/_[a-z]/) { |match| match[1].upcase }
+        name[0] = name[0].upcase
+        name
+      end
+
+      def dir_must_not_exist!
+        if File.exist? dir_name
+          raise DirectoryAlreadyExists, "directory #{dir_name} already exists!"
+        end
+      end
+
+      def class_name
+        titleize name
+      end
+
+      def dir_name
+        underscore name
+      end
+    end
+  end
+end

data/lib/clearwater/roda/template.rb

@@ -0,0 +1,34 @@
+require 'fileutils'
+
+module Clearwater
+  module Roda
+    class Template
+      attr_reader :input, :output, :options
+
+      def initialize input_filename, output_filename, options={}
+        @input = input_filename
+        @output = output_filename
+        @options = options
+      end
+
+      def write
+        if output.respond_to? :write
+          output.write content
+        else
+          FileUtils.mkdir_p File.dirname(output)
+          File.write output, content
+        end
+      end
+
+      def content
+        string = if input.respond_to? :read
+                   input.read
+                 else
+                   File.read(input)
+                 end
+
+        string % options
+      end
+    end
+  end
+end

data/lib/clearwater/roda/version.rb

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

data/lib/clearwater/roda.rb

@@ -0,0 +1,12 @@
+require 'clearwater/roda/version'
+require 'clearwater/roda/application'
+
+module Clearwater
+  module Roda
+    module_function
+
+    def build_app name
+      Application.new(name).build
+    end
+  end
+end

data/templates/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'opal'
+gem 'clearwater', '~> 1.0.0.rc4'
+gem 'roda'
+gem 'roda-opal_assets'
+
+group :development do
+  gem 'rerun'
+  gem 'rake'
+end

data/templates/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+require 'opal'
+require 'clearwater'
+require 'roda/opal_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
+  assets << 'app.js'
+  assets.build
+end

data/templates/app.rb

@@ -0,0 +1,30 @@
+require 'roda'
+require 'roda/opal_assets'
+require 'opal'
+require 'clearwater'
+
+class %{titleized_name} < Roda
+  plugin :public
+
+  assets = Roda::OpalAssets.new
+
+  route do |r|
+    r.public
+    assets.route r
+
+    <<-HTML
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>%{titleized_name}</title>
+  </head>
+
+  <body>
+    <div id="app"></div>
+    #{assets.js 'app.js'}
+  </body>
+</html>
+    HTML
+  end
+end

data/templates/assets/js/app.rb

@@ -0,0 +1,125 @@
+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
+
+router = Clearwater::Router.new do
+  # Routing targets are other components. They stick around for the life of the
+  # app, so they can store state or you can use them to fetch state from a data
+  # store somewhere else in your app.
+  #
+  # Syntax:
+  #   route path_segment => target
+  #   route another_segment => another_target do
+  #     route
+  #   end
+  route 'foo' => ChildRoute.new('foo')
+  route 'bar' => ChildRoute.new('bar') do
+    route 'baz' => ChildRoute.new('baz')
+  end
+end
+
+# The Clearwater app itself takes 3 args:
+app = Clearwater::Application.new(
+  # The component is any component that includes the Clearwater::Component mixin
+  component: Layout.new,
+
+  # This is the router we created above. If you're not using routing, you can
+  # safely omit this.
+  router: router,
+
+  # This is any existing element on the page. Note that it has to exist already
+  # at this point, so unless you're delaying the execution of this script with
+  # DOM events, you'll need to put the script tag below the element you're
+  # rendering into. This is usually accomplished by putting the script tag at
+  # the bottom of the <body> element.
+  element: Bowser.document['#app'],
+)
+
+# Uncomment the following line to display timing information in the console on
+# every render.
+#
+#   app.debug!
+
+# This adds the app to the Clearwater app registry (so it can be re-rendered on
+# route changes) and triggers the first render. Subsequent renders should use
+# app.render instead.
+app.call

data/templates/config.ru

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require './%{underscored_name}'
+
+$LOAD_PATH << 'lib'
+
+run %{titleized_name}

data/templates/dev

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+bundle check || bundle -j12
+
+rerun -i 'assets/**/*' 'rackup'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: clearwater-roda
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Gaskins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- jgaskins@gmail.com
+executables:
+- clearwater-roda
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clearwater-roda.gemspec
+- exe/clearwater-roda
+- lib/clearwater/roda.rb
+- lib/clearwater/roda/application.rb
+- lib/clearwater/roda/template.rb
+- lib/clearwater/roda/version.rb
+- templates/Gemfile
+- templates/Rakefile
+- templates/app.rb
+- templates/assets/js/app.rb
+- templates/config.ru
+- templates/dev
+homepage: https://github.com/clearwater-rb/clearwater-roda
+licenses: []
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Generate a Roda/Clearwater app from scratch
+test_files: []