rails_jskit 4.0.0

data/lib/generators/jskit/install/install_generator.rb

@@ -0,0 +1,98 @@
+module Jskit
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_controllers_directory
+        empty_directory "app/assets/javascripts/controllers"
+      end
+
+      def copy_controllers
+        template "app/assets/javascripts/controllers/application_controller.js"
+      end
+
+      def add_js_to_manifest
+        add_rails_jskit if manifest?
+      end
+
+      def append_jskit_to_application_layout
+        send("append_jskit_method_to_application_layout_#{layout_extension}") unless jskit_method_exists?
+      end
+
+      def create_initializer
+        template "config/initializers/rails_jskit.rb"
+      end
+
+      private
+
+      def add_rails_jskit
+        return if rails_jskit?
+        if require_tree?
+          gsub_file(js_manifest, /\/\/= require_tree \./, "//= require rails_jskit\n//= require_tree ./controllers\n")
+        else
+          append_to_file(js_manifest, "//= require rails_jskit\n//= require_tree ./controllers\n")
+        end
+      end
+
+      def jskit_method_snippet
+        method = case layout_extension
+        when :erb
+          "<%= jskit %>"
+        when :haml
+          "= jskit"
+        end
+
+        "\n#{body_indentation}#{method}\n"
+      end
+
+      def jskit_method_exists?
+        !!layout_file_content.match(/\= jskit/)
+      end
+
+      def layout_file_content
+        File.exists?(layout_file) ? File.read(layout_file) : ""
+      end
+
+      def body_indentation
+        "#{layout_file_content.match(/^(\s+)%body/)[1]}  "
+      end
+
+      def layout_file
+        @layout_file ||= Dir["app/views/layouts/application.html*"].first
+      end
+
+      def append_jskit_method_to_application_layout_erb
+        insert_into_file layout_file, jskit_method_snippet, before: "</body>"
+      end
+
+      def append_jskit_method_to_application_layout_haml
+        append_to_file layout_file, jskit_method_snippet
+      end
+
+      def layout_extension
+        File.extname(layout_file).gsub(/^\./, "").to_sym
+      end
+
+      def js_manifest
+        "app/assets/javascripts/application.js"
+      end
+
+      def add_js_to_manifest
+        if File.exists? js_manifest
+          if has_jquery?
+            insert_into_file js_manifest, "//= require lodash\n", before: "//= require jquery\n" unless has_lodash?
+          else
+            append_to_file js_manifest, "//= require lodash\n//= require jquery\n"
+          end
+          append_to_file js_manifest, "//= require rails_jskit\n//= require_tree ./controllers\n"
+        end
+      end
+
+      private
+
+      def application_js
+        @application_js ||= File.read js_manifest
+      end
+    end
+  end
+end

data/lib/generators/jskit/install/templates/app/assets/javascripts/controllers/application_controller.js

@@ -0,0 +1,5 @@
+<%= RailsJskit.configuration.app_namespace %>.createController("Application", {
+  all: function() {
+    console.log("JSkit installed!");
+  }
+});

data/lib/generators/jskit/install/templates/config/initializers/rails_jskit.rb

@@ -0,0 +1,4 @@
+RailsJskit.configure do |config|
+  # Change the JSkit Application global namespace (defaults to `App`)
+  # config.app_namespace = 'App'
+end

data/lib/generators/jskit/jskit_generator.rb

@@ -0,0 +1,9 @@
+module Jskit
+  # @private
+  module Generators
+    # @private
+    class Base < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+    end
+  end
+end

data/lib/rails_jskit/configuration.rb

@@ -0,0 +1,9 @@
+module RailsJskit
+  class Configuration
+    attr_accessor :app_namespace
+
+    def initialize
+      self.app_namespace = "App"
+    end
+  end
+end

data/lib/rails_jskit/engine.rb

@@ -0,0 +1,11 @@
+module RailsJskit
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsJskit
+    config.to_prepare do
+      decorators_path = File.join(RailsJskit::Engine.config.root, "app", "decorators", "**", "rails_jskit", "**", "*_decorator.rb")
+      Dir.glob(decorators_path).each do |decorator|
+        require_dependency(decorator)
+      end
+    end
+  end
+end

data/lib/rails_jskit/version.rb

@@ -0,0 +1,3 @@
+module RailsJskit
+  VERSION = File.read(File.join(File.expand_path("../../..", __FILE__), "VERSION"))
+end

data/lib/rails_jskit.rb

@@ -0,0 +1,16 @@
+require "rails_jskit/engine"
+require "rails_jskit/configuration"
+
+module RailsJskit
+  class << self
+    attr_accessor :configuration
+
+    def configure(&block)
+      fail ArgumentError, "RailsJskit#configure requires a block" if block.nil?
+      self.configuration = Configuration.new
+      block.call(configuration)
+    end
+  end
+end
+
+RailsJskit.configuration = RailsJskit::Configuration.new

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,59 @@
+require "rails_helper"
+
+class OrdersController < ApplicationController
+end
+
+describe OrdersController, type: :controller do
+  shared_examples "a payload setter" do |payload_type|
+    describe "#set_#{payload_type}_payload" do
+      it "sets the #{payload_type}_payload to an array of the passed arguments" do
+        controller.send("set_#{payload_type}_payload", "foo")
+        expect(assigns("#{payload_type}_payload")).to eq(', "foo"')
+
+        controller.send("set_#{payload_type}_payload", "foo", "bar", "baz")
+        expect(assigns("#{payload_type}_payload")).to eq(', "foo", "bar", "baz"')
+
+        controller.send("set_#{payload_type}_payload", ["foo", "bar", "baz"])
+        expect(assigns("#{payload_type}_payload")).to eq(', ["foo","bar","baz"]')
+      end
+    end
+  end
+
+  it_behaves_like "a payload setter", :action
+  it_behaves_like "a payload setter", :controller
+  it_behaves_like "a payload setter", :app
+
+  describe "#jskit" do
+    let(:view_context) { controller.view_context }
+
+    before do
+      controller.action_name = "action"
+    end
+
+    it "returns a script tag with the global event and the controller event" do
+      app_event = "App.Dispatcher.trigger(\"controller:application:all\", \"baz\");"
+      controller_event = "App.Dispatcher.trigger(\"controller:orders:all\", \"bar\");"
+      action_event = "App.Dispatcher.trigger(\"controller:orders:action\", \"foo\");"
+      expected_js = view_context.javascript_tag([app_event, controller_event, action_event].join("\n"))
+
+      controller.set_action_payload("foo")
+      controller.set_controller_payload("bar")
+      controller.set_app_payload("baz")
+
+      expect(controller.jskit).to eq(expected_js)
+    end
+
+    it "is exposed as a helper method" do
+      expect(controller.view_context.jskit).to eq(controller.jskit)
+    end
+
+    it "namespaces events based on the config" do
+      app_event = "App.Dispatcher.trigger(\"some_namespace:controller:application:all\");"
+      controller_event = "App.Dispatcher.trigger(\"some_namespace:controller:orders:all\");"
+      action_event = "App.Dispatcher.trigger(\"some_namespace:controller:orders:action\");"
+      expected_js = view_context.javascript_tag([app_event, controller_event, action_event].join("\n"))
+
+      expect(controller.jskit(namespace: "some_namespace")).to eq(expected_js)
+    end
+  end
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,12 @@
+require "rails_helper"
+
+describe RailsJskit::Configuration do
+  it "has s default app_namespace" do
+    expect(subject.app_namespace).to eq("App")
+  end
+
+  it "allows you to set the app_namespace" do
+    subject.app_namespace = "Test"
+    expect(subject.app_namespace).to eq("Test")
+  end
+end

data/spec/lib/jskit_rails_spec.rb

@@ -0,0 +1,12 @@
+require "rails_helper"
+
+describe RailsJskit do
+  describe "#configure" do
+    it "allows you to set configuration values" do
+      RailsJskit.configure do |config|
+        config.app_namespace = "Test"
+      end
+      expect(subject.configuration.app_namespace).to eq("Test")
+    end
+  end
+end

data/spec/lib/version_spec.rb

@@ -0,0 +1,7 @@
+require "rails_helper"
+
+describe RailsJskit::VERSION do
+  it "reads the version from the VERSION file" do
+    expect(RailsJskit::VERSION).to eq(File.read(File.join(File.expand_path("../../..", __FILE__), "VERSION")))
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: rails_jskit
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Dayton Nolan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-23 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: rails_jskit provides jskit.js to the asset pipeline and allows seamless
+  event dispatching from your rails application to jskit.
+email:
+- daytonn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- app/assets/javascripts/jskit.js
+- app/assets/javascripts/rails_jskit.js.erb
+- app/decorators/controllers/rails_jskit/application_controller_decorator.rb
+- lib/generators/jskit/USAGE
+- lib/generators/jskit/controller/templates/app/assets/javascripts/controllers/controller.js
+- lib/generators/jskit/install/USAGE
+- lib/generators/jskit/install/install_generator.rb
+- lib/generators/jskit/install/templates/app/assets/javascripts/controllers/application_controller.js
+- lib/generators/jskit/install/templates/config/initializers/rails_jskit.rb
+- lib/generators/jskit/jskit_generator.rb
+- lib/rails_jskit.rb
+- lib/rails_jskit/configuration.rb
+- lib/rails_jskit/engine.rb
+- lib/rails_jskit/version.rb
+- spec/controllers/application_controller_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/jskit_rails_spec.rb
+- spec/lib/version_spec.rb
+homepage: https://github.com/daytonn/rails_jskit
+licenses:
+- Apache 2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem that provides Rails integration for jskit
+test_files:
+- spec/controllers/application_controller_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/jskit_rails_spec.rb
+- spec/lib/version_spec.rb
+has_rdoc: