cljs-rails 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99eac71752ed07706c4278dd70e26b2a4813a3d8
-  data.tar.gz: 1bde622ed0b2aef66366d961a2225eca6c97a2c2
+  metadata.gz: bd6cef6766fcac9f8b44fd2a40fb77322ba79ea6
+  data.tar.gz: 7e1d2fdcdcfcfc72b23ec85cfd8aeff2fb81b1db
 SHA512:
-  metadata.gz: 4215b35ed131537d4f639564b27dbdf64c6e311fff209276e00db1c8e29bfa855449ec1afdedc31fcd11bcd4ec9845ed34f7b6b6e28a19da963180fa6582d357
-  data.tar.gz: 15c8899a4136bded4a88ac1d0f6a1f2236f374975fd84716fe3c340ac40990c7f03b6a855e6209d4920bffa8dcf77389f4654c07a743a05ece6b2a31950ff828
+  metadata.gz: c97336ac15cae78c2fa1c1259ceffc0cd8ee812f8bf2c5036d4c56ec35b57d1b74e7cbe3489965574615963ae4f9b446c80f1d5afa24836ee0617d71171f30de
+  data.tar.gz: 4368c85ad3736ecbc0b185029b9060e9583f9e30b892d78300592c960ccd835dd000817594f7873f10b019319b04fe1a3826c7057327e9b9c0313e6ff899f671

data/.gitignore

@@ -7,8 +7,12 @@
 /pkg/
 /spec/reports/
 /tmp/
+/log
 *.bundle
 *.so
 *.o
 *.a
 mkmf.log
+*.gem
+*.gemfile.lock
+

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+ - "2.1.7"
+ - "2.2.2"
+ - "2.3.1"
+gemfile:
+ - gemfiles/rails_4.gemfile
+ - gemfiles/rails_5.gemfile
+script: bundle exec rspec
+

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails-4" do
+  gem "rails", "4.2.7"
+end
+
+appraise "rails-5" do
+  gem "rails", "5.0.1"
+end

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cljs-rails.gemspec
+gem 'rspec'
+gem 'rake'
+gem 'appraisal'
 gemspec

data/README.md

@@ -1,9 +1,26 @@
-# Cljs::Rails
+[![Build Status](https://travis-ci.org/bogdan-dumitru/cljs-rails.svg?branch=master)](https://travis-ci.org/bogdan-dumitru/cljs-rails) [![Gem Version](https://badge.fury.io/rb/cljs-rails.svg)](http://badge.fury.io/rb/cljs-rails)
 
-TODO: Write a gem description
+# cljs-rails
+
+**Join the functional bandwagon now in just a few easy steps!**
+
+If you're reading this you're either:
+
+- (a) sitting in lawnchair relaxed because you've [found happiness](https://www.youtube.com/watch?v=A0VaIKK2ijM)
+- (b) on your way to becoming fundamentally a better person
+
+**cljs-rails** wants to help you integrate clojurescript into an existing Rails application without too much hassle. It depends [boot](https://github.com/boot-clj/boot) on boot for building your assets and provide a minimal template to get up and running fast with that functional goodness. 
+
+## Boot vs Leiningen
+
+> Potential for flamewar, check.
+
+I'm new to the clojurescript universe and after playing around a bit with the tools I found boot to provide a smoother startup experience, especially for people who are just getting started with the ecosystem. Granted the design choice diverges a bit from the *data all the way down* that we hold dear, their [arguments](https://news.ycombinator.com/item?id=8553189) seem to hold water.
 
 ## Installation
 
+First install boot. See the [install guide](https://github.com/boot-clj/boot#install) for more info.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -18,9 +35,78 @@ Or install it yourself as:
 
     $ gem install cljs-rails
 
-## Usage
+Run the generator
+  
+    $ bundle exec rails generate cljs_rails:install <optional app-name, defaults to the rails app name>
+
+Bundle install again because the generator adds a new dependency (foreman)
+
+    $ bundle
+
+## Post-Install
+
+Because the cljs build (powered by boot) needs to be run in parallel with the rails server, ``foreman`` was added to the gemfile and a basic ``Procfile`` that starts both these processes. So from now on instead of ``bundle exec rails server`` you should do:
+
+    $ foreman start
+
+> Because of the way clojure works the first time you start foreman (or run ``boot dev``) it will download all dependencies and also build your project. This is the equivalent, in webpack world, of doing both the ``npm install`` and ``webpack build``. Subsequent builds will not download depndencies and of course the dev tasks starts a watch that does hot-reloading and incremental builds (2k17).
+
+Currently the bundle isn't loaded anywhere in your Rails app, you must add it to your layout using the ``cljs_main_path`` helper:
+
+```erb
+<%= javascript_include_tag cljs_main_path %>
+```
+
+After doing this you should navigate to an action and see clojurescript devtools messages in your browser console. 
+
+Also, the generated core/main function injects "Hello world" into the document body. 
+You can go to ``cljs/src/<app-name>/core.cljs`` and edit the text there. It should automagically recompile and run again in the browser! Yey!
+
+## Notes
+
+### Structure
+
+The generator sets up a ``cljs`` folder with the source, a main and a namespace derived from the rails app name.
+
+```
+▾ cljs/
+  ▾ src/
+    ▾ <app-name>/
+        core.cljs
+      main.cljs.edn
+```
+
+> You can provide a different name as the first argument of the install generator.
+
+### Production
+
+There's a rake tasks provided ``cljs:compile`` that builds for production (with advanced optimisations).
+It just runs ``boot #{production_task}``. Production task defaults to "prod" and is defined in the ``build.boot`` template, but you can configure it via ``config.cljs.production_build_task``.
+
+The production build is configured by default to output to ``app/assets/cljs-build/``. This means that the sprockets can now find it.
+The ``cljs_main_path`` helper will just return "main.js" when in production so sprokets will pickup the build file. In development/test it uses the dev-server settings.
+
+> By default ``app/assets/cljs-build`` is added to gitignore just in case, but you might want to (due to some limitations in your environemnt, but you shouldn't) commit your build artefacts to the repo.
+
+#### Deployment to heroku
+
+> WIP: Need to experiment with buildpacks and setup an example repo.
+
+You can enhance the ``assets:precompile`` task so that it runs ``cljs:compile``. Add this to a rake file:
+
+```ruby
+Rake::Task['assets:precompile'].enhance ['cljs:compile']
+```
+
+Now as long as there's a proper buildpack being used that has ``boot`` installed, everything should work.
+
+#### Custom deployment
+
+Same logic as above should apply as long as you attach the compile task to run before ``assets:precompile``, and the server that's managing your build has ``boot`` setup.
+
+## Prior art
 
-TODO: Write usage instructions here
+- [webpack-rails](https://github.com/mipearson/webpack-rails)
 
 ## Contributing
 

data/cljs-rails.gemspec

@@ -13,12 +13,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = ""
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 2.1.0'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rails", ">= 3.2.0"
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "railties", ">= 4.2.7"
+  spec.add_development_dependency "rails", ">= 4.2.7"
 end

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec"
+gem "rake"
+gem "appraisal"
+gem "rails", "4.2.7"
+
+gemspec :path => "../"

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec"
+gem "rake"
+gem "appraisal"
+gem "rails", "5.0.1"
+
+gemspec :path => "../"

data/lib/cljs-rails.rb

@@ -0,0 +1 @@
+require 'cljs/rails'

data/lib/cljs/rails.rb

@@ -1,7 +1,3 @@
 require "cljs/rails/version"
+require 'cljs/railtie' if defined? ::Rails::Railtie
 
-module Cljs
-  module Rails
-    # Your code goes here...
-  end
-end

data/lib/cljs/rails/helper.rb

@@ -0,0 +1,43 @@
+require 'action_view'
+
+module Cljs
+  module Rails
+    # Asset path helpers for use with webpack
+    module Helper
+      # Return asset paths for a particular webpack entry point.
+      #
+      # Response may either be full URLs (eg http://localhost/...) if the dev server
+      # is in use or a host-relative URl (eg /webpack/...) if assets are precompiled.
+      #
+      # Will raise an error if our manifest can't be found or the entry point does
+      # not exist.
+      def cljs_main_path
+        if ::Rails.env.production?
+          cljs_main_prod_path
+        else
+          cljs_main_dev_path
+        end
+      end
+
+      def cljs_main_prod_path
+        # ``app/assets/cljs-build`` has to be added to the asset paths
+        main = ::Rails.configuration.cljs.main_target
+        "#{main}.js"
+      end
+
+      def cljs_main_dev_path
+        port = ::Rails.configuration.cljs.dev_server.port
+        protocol = ::Rails.configuration.cljs.dev_server.https ? 'https' : 'http'
+        main = ::Rails.configuration.cljs.main_target
+
+        host = ::Rails.configuration.cljs.dev_server.host
+        host = instance_eval(&host) if host.respond_to?(:call)
+
+        # if ::Rails.env.developmtn
+
+        "#{protocol}://#{host}:#{port}/#{main}.js"
+      end
+
+    end
+  end
+end

data/lib/cljs/rails/version.rb

@@ -1,5 +1,5 @@
 module Cljs
   module Rails
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/cljs/railtie.rb

@@ -0,0 +1,26 @@
+require 'rails'
+require 'rails/railtie'
+require 'cljs/rails/helper'
+
+module Cljs
+  # :nodoc:
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      ActiveSupport.on_load(:action_view) do
+        include Cljs::Rails::Helper
+      end
+    end
+
+    config.cljs = ActiveSupport::OrderedOptions.new
+    config.cljs.dev_server = ActiveSupport::OrderedOptions.new
+
+    config.cljs.production_build_task = "prod"
+    config.cljs.dev_server.port = 5555
+    config.cljs.dev_server.host = 'localhost'
+    config.cljs.main_target = 'main'
+
+    rake_tasks do
+      load "tasks/cljs.rake"
+    end
+  end
+end

data/lib/generators/cljs_rails/install_generator.rb

@@ -0,0 +1,66 @@
+module CljsRails
+  # :nodoc:
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+
+    desc "Install everything you need for a basic cljs-rails integration"
+
+    argument :app_name,
+             type: :string,
+             default: ::Rails.application.class.parent_name.downcase,
+             banner: "app_name"
+
+
+    def add_foreman_to_gemfile
+      gem 'foreman'
+    end
+
+    def copy_procfile
+      copy_file "Procfile", "Procfile"
+    end
+
+    def copy_build_boot
+      template("build.boot", "build.boot")
+    end
+
+    def copy_boot_properties
+      copy_file "boot.properties", "boot.properties"
+    end
+
+    def create_core_cljs
+      empty_directory "cljs/src/#{app_name}"
+      template("core.cljs", "cljs/src/#{app_name}/core.cljs")
+    end
+
+    def create_main_edn
+      template("main.cljs.edn", "cljs/src/main.cljs.edn")
+    end
+
+    def add_to_gitignore
+      append_to_file ".gitignore" do
+        <<-EOF.strip_heredoc
+        # Added by cljs-rails
+        /app/assets/cljs-build
+        .nrepl-port
+        EOF
+      end
+    end
+
+    def whats_next
+      puts <<-EOF.strip_heredoc
+
+        We've set up the basics of clojurescript-rails for you, but you'll still
+        need to:
+
+          1. Add the 'main' entry point into your layout, and
+          2. Run 'foreman start' to run the boot build and rails server
+
+        See the README.md for this gem at
+        https://github.com/bogdan-dumitru/cljs-rails/blob/master/README.md
+        for more info.
+
+        Have a functional day!
+      EOF
+    end
+  end
+end

data/lib/generators/templates/Procfile

@@ -0,0 +1,4 @@
+# Run Rails & Webpack concurrently
+# Example file from webpack-rails gem
+rails: bundle exec rails server
+boot: boot dev

data/lib/generators/templates/boot.properties

@@ -0,0 +1,2 @@
+BOOT_CLOJURE_VERSION=1.8.0
+BOOT_VERSION=2.7.1

data/lib/generators/templates/build.boot

@@ -0,0 +1,32 @@
+(set-env!
+ :resource-paths  #{"cljs/src"}
+ :dependencies '[[adzerk/boot-cljs      "1.7.228-2" :scope "test"]
+                 [adzerk/boot-cljs-repl "0.3.3"      :scope "test"]
+                 [adzerk/boot-reload    "0.5.0"      :scope "test"]
+                 [pandeiro/boot-http    "0.7.6"      :scope "test"]
+                 [crisptrutski/boot-cljs-test "0.2.2-SNAPSHOT" :scope "test"]
+                 [org.clojure/clojure "1.8.0"]
+                 [org.clojure/clojurescript "1.9.89"]
+                 [com.cemerick/piggieback     "0.2.1"          :scope "test"]
+                 [weasel                      "0.7.0"          :scope "test"]
+                 [org.clojure/tools.nrepl     "0.2.12"         :scope "test"]
+                 [binaryage/devtools "0.8.1"]])
+
+(require
+  '[adzerk.boot-cljs      :refer [cljs]]
+  '[adzerk.boot-cljs-repl :refer [cljs-repl start-repl]]
+  '[adzerk.boot-reload    :refer [reload]]
+  '[crisptrutski.boot-cljs-test  :refer [exit! test-cljs]]
+  '[pandeiro.boot-http    :refer [serve]])
+
+(deftask dev []
+  (comp (serve :port 5555)
+        (watch)
+        (speak)
+        (reload :asset-host "http://localhost:5555" :on-jsload '<%= app_name %>.core/main)
+        (cljs-repl)
+        (cljs :source-map true :optimizations :none)))
+
+(deftask prod []
+  (comp (cljs :optimizations :advanced)
+        (target :dir #{"app/assets/cljs-build"})))

data/lib/generators/templates/core.cljs

@@ -0,0 +1,11 @@
+(ns <%= app_name %>.core
+  (:require [devtools.core :as devtools]
+            [clojure.browser.dom :as dom]))
+
+;; -- Debugging aids ----------------------------------------------------------
+(devtools/install!)       ;; we love https://github.com/binaryage/cljs-devtools
+(enable-console-print!)   ;; so that println writes to `console.log`
+
+(defn ^:export main
+  []
+  (dom/append (.-body js/document) (dom/element "div" "Hello world edit me now!")))

data/lib/generators/templates/main.cljs.edn

@@ -0,0 +1,3 @@
+{:require  [<%= app_name %>.core]
+ :init-fns [<%= app_name %>.core/main]
+ :compiler-options {:asset-path "http://localhost:5555/main.out"}}

data/lib/tasks/cljs.rake

@@ -0,0 +1,14 @@
+namespace :cljs do
+  desc "Compile clojurescript for production"
+  task compile: :environment do
+    production_build_task = Rails.configuration.cljs.production_build_task
+
+    run_build = %{
+      type boot >/dev/null 2>&1 ||
+        { echo >&2 "[ERROR] Boot is not installed."; exit 1; }
+      boot #{production_build_task}
+    }
+
+    sh run_build, verbose: false
+  end
+end

data/spec/helper_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe 'cljs_main_path' do
+  include Cljs::Rails::Helper
+  before(:each) do
+    # Reset configuration
+    ::Rails.configuration.cljs.main_target = "main"
+    ::Rails.configuration.cljs.dev_server.port = 5555
+    ::Rails.configuration.cljs.dev_server.host = 'localhost'
+  end
+
+  it "should use https protocol when https is true" do
+    ::Rails.configuration.cljs.dev_server.https = true
+    expect(cljs_main_path).to be_starts_with('https:')
+  end
+
+  it "should use http protocol when https is false" do
+    ::Rails.configuration.cljs.dev_server.https = false
+    expect(cljs_main_path).to be_starts_with('http:')
+  end
+
+  context "when in development" do
+    before do
+      allow(Rails.env).to receive :production? { false }
+      allow(Rails.env).to receive :development? { true }
+    end
+
+    it "should have the user talk to the dev server" do
+      ::Rails.configuration.cljs.dev_server.port = 4000
+      ::Rails.configuration.cljs.dev_server.host = 'boot-dev-server.host'
+
+      expect(cljs_main_path).to eq("http://boot-dev-server.host:4000/main.js")
+    end
+  end
+
+  context "when in prouction" do
+    before do
+      allow(Rails.env).to receive :production? { true }
+      allow(Rails.env).to receive :development? { false }
+    end
+
+    it "should have the user talk to the dev server" do
+      ::Rails.configuration.cljs.dev_server.port = 4000
+      ::Rails.configuration.cljs.dev_server.host = 'boot-dev-server.host'
+
+      expect(cljs_main_path).to eq("main.js")
+    end
+  end
+
+  it "should use the main target configuration if specified" do
+    ::Rails.configuration.cljs.main_target = "apples"
+    expect(cljs_main_path).to be_ends_with("apples.js")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "rspec"
+require "rails"
+require "cljs/rails"
+
+module Dummy
+  # :nodoc:
+  class Application < Rails::Application
+    config.eager_load = false
+  end
+end
+
+Rails.application.initialize!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cljs-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Bogdan Dumitru
@@ -11,47 +11,33 @@ cert_chain: []
 date: 2017-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
-  type: :development
+        version: 4.2.7
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.7
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 4.2.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 4.2.7
 description: Boot powered helpers to get up and running fast with Clojurescript in
   your Rails application
 email:
@@ -61,13 +47,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - cljs-rails.gemspec
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_5.gemfile
+- lib/cljs-rails.rb
 - lib/cljs/rails.rb
+- lib/cljs/rails/helper.rb
 - lib/cljs/rails/version.rb
+- lib/cljs/railtie.rb
+- lib/generators/cljs_rails/install_generator.rb
+- lib/generators/templates/Procfile
+- lib/generators/templates/boot.properties
+- lib/generators/templates/build.boot
+- lib/generators/templates/core.cljs
+- lib/generators/templates/main.cljs.edn
+- lib/tasks/cljs.rake
+- spec/helper_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -80,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -88,8 +90,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Clojurescript integration for Rails, inspired by webpack-rails
-test_files: []
+test_files:
+- spec/helper_spec.rb
+- spec/spec_helper.rb