t3-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbfb2287b40b6b9a0382065e4dfd22ca90c0f8a5
+  data.tar.gz: 841a9684161684840b841df46a4e574c802cd7b7
+SHA512:
+  metadata.gz: 579a88e36b6d8a2a30de4ee303e42213d34a34909f250e6f0cf419b62b092ebb551fdc2f892824b1e63639392f437a9de4c6b5439ed1efe2e9927b94ed33a98a
+  data.tar.gz: b493e2ce472bcc51d6028073f1db9222984df6d9e8024bc22a63fdf696f79afe5e5d7e8c52e39c86af9cf831a09a0f2a62c199f65ec8aaede37d8983414ebe47

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Dom Christie
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# t3-rails
+
+Easily set up the [T3 JavaScript framework](http://t3js.org/) within your Rails 4+ application.
+
+This gem includes the T3 assets (including the T3 testing bundle), along with generators for setting up application structure and for creating modules, services, and behaviors.
+
+**Note**: this gem is currently in development and as such has not been thoroughly tested in the wild. Testing and improvements (particularly regarding older versions of Ruby/Rails) are welcome!
+
+## Getting Started
+
+Add the gem to your application Gemfile:
+
+```ruby
+gem 't3-rails'
+```
+
+Run `bundle install`, then generate the application structure:
+
+```
+rails g t3:bootstrap
+```
+
+Initialize your T3 app by calling `Box.Application.init()`. As the [T3 docs](http://t3js.org/docs/getting-started/application) suggest, you may want to call `init()`:
+
+> - Inline at the bottom of the page
+> - In a window.onload event handler
+> - In a DOMContentLoaded event handler
+
+For example to initialize on DOM ready and on page load (a Turbolinks event), you may want to include the following:
+
+```javascript
+(function() {
+  var init = function() { Box.Application.init(); };
+  $(document).ready(init).on('page:load', init);
+})();
+```
+
+## Generators
+
+### `bootstrap`
+
+```
+rails g t3:bootstrap
+```
+
+Sets up `modules`, `services`, and `behaviors` directories in `app/assets/javascripts`. Injects `require` statements in `application.js` for including the `t3.js` and the component directories.
+
+### `module`
+
+```
+rails g t3:module name
+```
+
+Creates a new module in the `modules` directory.
+
+### `service`
+
+```
+rails g t3:service name
+```
+
+Creates a new service in the `services` directory.
+
+### `behavior`
+
+```
+rails g t3:behavior name
+```
+
+Creates a new behavior in the `behaviors` directory.
+
+## Copyright and Licenses
+
+t3-rails is copyright © 2015 Dom Christie and released under the MIT license. T3 is licensed under the Apache License, Version 2.0.

data/Rakefile

@@ -0,0 +1,41 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'T3Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc "Update T3 versions"
+task :update_t3 do
+  def download_t3(version)
+    %w(t3 t3.min t3-testing).each do |file_name|
+      puts "Downloading #{file_name}.js"
+      puts `curl -o vendor/assets/javascripts/#{file_name}.js http://cdn.rawgit.com/box/t3js/v#{version}/dist/#{file_name}.js`
+    end
+  end
+
+  download_t3(T3::Rails::T3_VERSION)
+  puts "\e[32mDone!\e[0m"
+end
+
+task default: :test

data/lib/generators/t3/behavior_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/t3/generator_helper'
+
+module T3
+  module Generators
+    class BehaviorGenerator < ::Rails::Generators::NamedBase
+      include T3::Generators::GeneratorHelper
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc 'Creates a new T3 behavior'
+
+      def create_behavior_files
+        create_component_files
+      end
+    end
+  end
+end

data/lib/generators/t3/bootstrap_generator.rb

@@ -0,0 +1,42 @@
+require 'generators/t3/generator_helper'
+
+module T3
+  module Generators
+    class BootstrapGenerator < ::Rails::Generators::Base
+      include T3::Generators::GeneratorHelper
+
+      desc 'Sets up T3 and default asset directories'
+      class_option :skip_git, type: :boolean, aliases: '-g', default: false, desc: 'Do not create .gitkeep files'
+
+      def create_directories
+        components.each do |c|
+          empty_directory "#{install_path}/#{c}"
+          create_file "#{install_path}/#{c}/.gitkeep" unless options[:skip_git]
+        end
+      end
+
+      def inject_t3
+        requires = "//= require t3\n"
+
+        requires += components.map { |dir|
+          "//= require_tree ./#{dir}"
+        }.join("\n") + "\n"
+
+        inject_into_file "#{install_path}/application.js", requires,
+          before: '//= require_tree .'
+
+        # If //= require_tree . does not exist, inject at the bottom
+        # (Thor ensures that the content is not injected more than once)
+        inject_into_file "#{install_path}/application.js", requires,
+          before: %r{\z}
+      end
+
+    private
+
+      def components
+        %W{behaviors modules services}
+      end
+
+    end
+  end
+end

data/lib/generators/t3/generator_helper.rb

@@ -0,0 +1,19 @@
+module T3
+  module Generators
+    module GeneratorHelper
+    private
+
+      def install_path
+        'app/assets/javascripts'
+      end
+
+      def create_component_files
+        generator_name = self.class.generator_name
+
+        template "#{generator_name}.js",
+          File.join(install_path, generator_name.pluralize, "#{file_path}.js")
+      end
+
+    end
+  end
+end

data/lib/generators/t3/module_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/t3/generator_helper'
+
+module T3
+  module Generators
+    class ModuleGenerator < ::Rails::Generators::NamedBase
+      include T3::Generators::GeneratorHelper
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc 'Creates a new T3 module'
+
+      def create_module_files
+        create_component_files
+      end
+    end
+  end
+end

data/lib/generators/t3/service_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/t3/generator_helper'
+
+module T3
+  module Generators
+    class ServiceGenerator < ::Rails::Generators::NamedBase
+      include T3::Generators::GeneratorHelper
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc 'Creates a new T3 service'
+
+      def create_service_files
+        create_component_files
+      end
+    end
+  end
+end

data/lib/generators/templates/behavior.js

@@ -0,0 +1,45 @@
+/**
+ * @fileoverview Description of file
+ * @author your name
+ */
+
+/*global Box*/
+
+/**
+ * Description of behavior.
+ */
+Box.Application.addBehavior('<%= class_name.underscore %>', function(context) {
+
+  'use strict';
+
+  //-----------------------------------------------------------
+  // Private
+  //-----------------------------------------------------------
+
+  /**
+   * Description of function.
+   * @param {type} name Description
+   * @returns {type} Description
+   * @private
+   */
+  function privateFunction(name) {
+
+  }
+
+  //-----------------------------------------------------------
+  // Public
+  //-----------------------------------------------------------
+
+  return {
+
+    /**
+     * Description of method.
+     * @param {type} name Description
+     * @returns {type} Description
+     */
+    method: function(name) {
+
+    }
+  };
+
+});

data/lib/generators/templates/module.js

@@ -0,0 +1,45 @@
+/**
+ * @fileoverview Description of file
+ * @author your name
+ */
+
+/*global Box*/
+
+/**
+ * Description of module.
+ */
+Box.Application.addModule('<%= class_name.underscore %>', function(context) {
+
+  'use strict';
+
+  //-----------------------------------------------------------
+  // Private
+  //-----------------------------------------------------------
+
+  /**
+   * Description of function.
+   * @param {type} name Description
+   * @returns {type} Description
+   * @private
+   */
+  function privateFunction(name) {
+
+  }
+
+  //-----------------------------------------------------------
+  // Public
+  //-----------------------------------------------------------
+
+  return {
+
+    /**
+     * Description of method.
+     * @param {type} name Description
+     * @returns {type} Description
+     */
+    method: function(name) {
+
+    }
+  };
+
+});

data/lib/generators/templates/service.js

@@ -0,0 +1,45 @@
+/**
+ * @fileoverview Description of file
+ * @author your name
+ */
+
+/*global Box*/
+
+/**
+ * Description of service.
+ */
+Box.Application.addService('<%= class_name.underscore %>', function(application) {
+
+  'use strict';
+
+  //-----------------------------------------------------------
+  // Private
+  //-----------------------------------------------------------
+
+  /**
+   * Description of function.
+   * @param {type} name Description
+   * @returns {type} Description
+   * @private
+   */
+  function privateFunction(name) {
+
+  }
+
+  //-----------------------------------------------------------
+  // Public
+  //-----------------------------------------------------------
+
+  return {
+
+    /**
+     * Description of method.
+     * @param {type} name Description
+     * @returns {type} Description
+     */
+    method: function(name) {
+
+    }
+  };
+
+});

data/lib/t3/rails.rb

@@ -0,0 +1,8 @@
+require "t3/rails/version"
+
+module T3
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/t3/rails/version.rb

@@ -0,0 +1,6 @@
+module T3
+  module Rails
+    VERSION = "0.1.0"
+    T3_VERSION = "1.4.0"
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.