seajs-rails 0.0.1

data/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+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,85 @@
+# Sea.js for Rails 3.x
+
+Integrates Sea.js into the Rails 3 Asset Pipeline.
+提供一种将 Sea.js 与 Asset Pipeline 结合起来的方式，底层通过 spm-chaos-build 来实现
+
+## 安装
+
+首先请安装好 spm-chaos-build ，参见 https://github.com/edokeh/spm-chaos-build
+
+    $ npm install spm -g
+    $ npm install spm-chaos-build -g
+
+然后在 Gemfile 中添加这个 gem
+
+    gem 'seajs-rails'
+
+并执行命令
+
+    $ bundle
+
+## 使用方式
+
+### 初始化
+
+执行以下命令初始化项目
+
+    $ rake seajs:setup
+
+这会安装最新版本的 Sea.js 到相应目录下，并在 config 目录生成 seajs_config.yml
+
+配置文件说明：
+
+```yaml
+seajs_path: seajs/seajs/2.0.0/sea.js  # 这是配置 seajs 的路径
+family: klog  # 与打包合并有关的参数，自动生成为项目的名称，一般不需要修改
+output:  # 合并策略，具体参见 spm-chaos-build
+  relative:
+    - application.js
+  all: []
+```
+
+ouput 项其实就是 package.json 中的 spm.output
+支持 relative（只合并相对路径）, all（合并所有路径） 两种方式
+
+目录说明：
+
+    your-rails
+    ├─app
+    │  ├─assets
+    │  │  ├─images
+    │  │  ├─javascripts
+    │  │  │  ├─a.js    <-- your js code
+    │  │  │  └─sea-modules    <-- seajs base 目录
+    │  │  │      ├─gallery
+    │  │  │      ├─jquery
+    │  │  │      └─seajs
+    │  │  │          └─seajs
+    │  │  │              └─2.0.0
+    │  │  └─stylesheets
+
+与普通的开发基本一致，只是在 javascripts 目录下多了一个 sea-modules 作为 Sea.js 的 base 目录
+普通的业务代码依然放置在 javascripts 目录下（非 CMD 模块的 JS 也放在这里）
+
+### 使用
+
+提供两个 helper 方法：seajs_tag 与 seajs_use
+
+```erb
+<%= seajs_tag %>
+<%= seajs_use 'blogs/show' %>
+```
+seajs_tag 用于引入 seajs ，并且会根据是否合并引入必要的配置
+seajs_use 用于加载 CMD 模块，支持传递多个模块名称
+
+### 合并
+
+这个 gem 会将 seajs 的打包合并过程嵌入到 assets:precompile 任务中，所以执行这个命令
+
+    $ rake assets:precompile
+
+Sea.js 的合并过程不会与原有的 assets pipeline 冲突，但是请将配置分开
+* 需要合并的 CMD 模块文件请在 seajs_config.yml 中配置
+* 而非 CMD 模块的文件请依然通过 `config.assets.precompile` 配置
+
+合并完成后，不需要改动页面，两个 helper 方法能够自动处理

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/helpers/seajs_helper.rb

@@ -0,0 +1,36 @@
+module SeajsHelper
+  # generate seajs.use()
+  def seajs_use(*modules)
+    seajs_config = Rails.application.config.seajs
+
+    if seajs_config.compiled?
+      modules.map! { |m| seajs_config.family + '/' + m }
+    else
+      modules.map! { |m| '/assets/' + m }
+    end
+
+    html = <<-html
+    <script>
+    seajs.use(#{modules.to_s})
+    </script>
+    html
+
+    html.html_safe
+  end
+
+  # include seajs script and map config
+  def seajs_tag
+    seajs_config = Rails.application.config.seajs
+
+    html = <<-html
+      <script src="/assets/sea-modules/#{seajs_config.seajs_path}"></script>
+      <script>
+      seajs.config({
+        map: #{seajs_config.map_json || '[]'}
+      })
+      </script>
+    html
+
+    html.html_safe
+  end
+end

data/lib/seajs-rails.rb

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

data/lib/seajs/rails.rb

@@ -0,0 +1,5 @@
+module Seajs
+  module Rails
+    require 'seajs/rails/engine'
+  end
+end

data/lib/seajs/rails/config.rb

@@ -0,0 +1,32 @@
+require 'active_support/ordered_options'
+require 'yaml'
+
+module Seajs::Rails
+  class Config < ::ActiveSupport::OrderedOptions
+
+    def initialize
+      super
+      # config/seajs_config.yml
+      self.config_path = ::Rails.root.join('config', 'seajs_config.yml')
+      # public/assets/seajs_map.json
+      self.map_path = File.join(::Rails.public_path, ::Rails.application.config.assets.prefix, "seajs-map.json")
+    end
+
+    def load_config_from_file
+      if File.exist?(self.config_path)
+        self.merge! YAML.load_file(self.config_path).symbolize_keys
+      end
+
+      if File.exist?(self.map_path)
+        self.map_json = File.open(map_path).read
+        self.is_compiled = true
+      else
+        self.is_compiled = false
+      end
+    end
+
+    def compiled?
+      is_compiled
+    end
+  end
+end

data/lib/seajs/rails/engine.rb

@@ -0,0 +1,31 @@
+require 'seajs/rails/config'
+
+module Seajs
+  module Rails
+    class Engine < ::Rails::Engine
+
+      config.before_configuration do
+        config.seajs = Seajs::Rails::Config.new
+      end
+
+      config.before_initialize do |app|
+        config = app.config
+
+        # find the default precompile filter and modify it
+        index = config.assets.precompile.find_index do |filter|
+          filter.respond_to?(:call) && filter.call('sea.js.map')
+        end
+
+        if index
+          # add filter，don't precompile app/javascripts/sea-modules/
+          filter = Proc.new do |path|
+            !File.extname(path).in?(['.js', '.css']) and !path.start_with?('sea-modules/')
+          end
+          config.assets.precompile[index] = filter
+        end
+
+        config.seajs.load_config_from_file
+      end
+    end
+  end
+end

data/lib/seajs/rails/version.rb

@@ -0,0 +1,6 @@
+module Seajs
+  module Rails
+    VERSION = "0.0.1"
+    SEAJS_VERSION = "2.0.0"
+  end
+end

data/lib/tasks/seajs-rails.rake

@@ -0,0 +1,76 @@
+require 'seajs/rails/version'
+
+namespace :seajs do
+  desc "Check whether spm & spm-chaos-build is ok"
+  task :test_env do
+    begin
+      `spm-chaos-build -h`
+    rescue Errno::ENOENT
+      puts 'Please intall spm-chaos-build first.'
+      exit 1
+    end
+  end
+
+  desc 'init setup'
+  task :setup => :test_env do
+    # install seajs
+    path = Rails.root.join('app', 'assets', 'javascripts')
+    `cd #{path} && spm install seajs@#{Seajs::Rails::SEAJS_VERSION}`
+
+    # generate seajs config file
+    File.open(Rails.root.join('config', 'seajs_config.yml'), 'w') do |f|
+      config_temp = File.expand_path('../template/seajs_config.yml', __FILE__)
+      templ = Erubis::Eruby.new(File.open(config_temp).read)
+      f.write templ.result(:seajs_path => "seajs/seajs/#{Seajs::Rails::SEAJS_VERSION}/sea.js",
+                           :family => Rails.application.class.parent_name.downcase)
+    end
+  end
+
+  namespace :compile do
+    task :external do
+      ruby_rake_task "seajs:compile:all"
+    end
+
+    task :all => ["seajs:compile:prepare_dir",
+                  "seajs:compile:generate_json",
+                  "seajs:compile:build",
+                  "seajs:compile:clean"]
+
+    desc 'copy `app/assets/javascripts` to ``/public/assets/``'
+    task :prepare_dir do
+      cp_r Rails.root.join('app', 'assets', 'javascripts'), File.join(Rails.public_path, 'assets'), :remove_destination => true
+      cp File.expand_path('../template/Gruntfile.js', __FILE__), File.join(Rails.public_path, 'assets')
+    end
+
+    desc 'generate package.json by seajs_config.yml'
+    task :generate_json do
+      File.open(File.join(Rails.public_path, 'assets', 'javascripts', 'package.json'), 'w') do |f|
+
+        seajs_config = Rails.application.config.seajs
+        seajs_config.load_config_from_file
+        pkg = {:family => seajs_config.family, :spm => {:output => seajs_config.output}}
+        f.write pkg.to_json
+      end
+    end
+
+    desc 'run chaos-build in assets for `javascripts` dir'
+    task :build do
+      path = File.join(Rails.public_path, 'assets')
+      `cd #{path} && spm chaos-build javascripts`
+
+      unless $?.success?
+        raise RuntimeError, "spm chaos-build failed."
+      end
+    end
+
+    task :clean do
+      cp_r File.join(Rails.public_path, 'assets', 'javascripts', 'sea-modules', '.'), File.join(Rails.public_path, 'assets', 'sea-modules')
+      rm_rf File.join(Rails.public_path, 'assets', 'javascripts')
+      rm_rf File.join(Rails.public_path, 'assets', 'Gruntfile.js')
+    end
+  end
+end
+
+Rake::Task["assets:precompile"].enhance do
+  Rake::Task["seajs:compile:external"].invoke
+end

data/lib/tasks/template/Gruntfile.js

@@ -0,0 +1,30 @@
+var chaosBuild = require('spm-chaos-build');
+
+module.exports = function (grunt) {
+    chaosBuild.loadTasks(grunt);
+
+    var config = chaosBuild.getConfig('javascripts', {
+        outputDirectory : 'javascripts/sea-modules',
+        gzip : 'all'
+    });
+    grunt.initConfig(config);
+
+    grunt.registerTask('write-manifest', function () {
+        var mapArr = grunt.config.get('md5map');
+        var family = config.family;
+        grunt.file.write('seajs-map.json', JSON.stringify(mapArr, null, '\t'));
+    });
+
+    grunt.registerTask('chaos-build', [
+        'clean:dist', // delete dist direcotry first
+        'transport:spm',  // src/* -> .build/src/*
+        'concat:relative',  // .build/src/* -> .build/dist/*.js
+        'concat:all',
+        'uglify:js',  // .build/dist/*.js -> .build/dist/*.js
+        'md5:js', // .build/dist/*.js -> dist/*-md5.js
+        'clean:spm',
+        'spm-newline',
+        'compress',
+        'write-manifest'
+    ]);
+};

data/lib/tasks/template/seajs_config.yml

@@ -0,0 +1,6 @@
+seajs_path: <%= seajs_path %>
+family: <%= family %>
+output:
+  relative:
+    - application.js
+  all: []

data/seajs-rails.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seajs/rails/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "seajs-rails"
+  gem.version       = Seajs::Rails::VERSION
+  gem.authors       = ["edokeh"]
+  gem.email         = ["edokeh@163.com"]
+  gem.description   = %q{Integrates Sea.js into the Rails 3 Asset Pipeline.}
+  gem.summary       = %q{This gem provides Sea.js support for your Rails 3 application.}
+  gem.homepage      = "https://github.com/edokeh/seajs-rails"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "railties", ">= 3.1.1", "< 4.1"
+
+  gem.requirements << "spm-chaos-build is required for 'rake assets:precompile'. See https://github.com/edokeh/spm-chaos-build"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: seajs-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- edokeh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: Integrates Sea.js into the Rails 3 Asset Pipeline.
+email:
+- edokeh@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitattributes
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/seajs_helper.rb
+- lib/seajs-rails.rb
+- lib/seajs/rails.rb
+- lib/seajs/rails/config.rb
+- lib/seajs/rails/engine.rb
+- lib/seajs/rails/version.rb
+- lib/tasks/seajs-rails.rake
+- lib/tasks/template/Gruntfile.js
+- lib/tasks/template/seajs_config.yml
+- seajs-rails.gemspec
+homepage: https://github.com/edokeh/seajs-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- spm-chaos-build is required for 'rake assets:precompile'. See https://github.com/edokeh/spm-chaos-build
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: This gem provides Sea.js support for your Rails 3 application.
+test_files: []