RubyGems - js_erb - Versions diffs - 0.1.0 - Mend

Files changed (10) hide show

data/CHANGELOG.rdoc ADDED Viewed

@@ -0,0 +1,6 @@
+= JsErb - Changelog
+== js_erb v0.1.0 released 2010/05/08
+* initial release

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Kristijan Sedlak]
+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.rdoc ADDED Viewed

@@ -0,0 +1,54 @@
+= JsErb - Javascript renderer for Ruby on Rails
+Today's projects contain more and more javascript code. Thus, from the design perspective,
+javascript should be located under the RAILS/app directory instead of RAILS/public. Javascript
+usually produces at least a small piece of HTML code thus the Javascript templating is needed.
+Sites also require translations. Finally there are cases when you really need to put some
+ruby code into javascript. These are the features of the JsErb plugin.
+== Installation (Rails 3 ready)
+Add this line to your Gemfile
+  gem 'js_erb'
+Move public/javascripts directory to app/javascripts. Files with *.jserb extension can contain
+ERB-styled ruby code (e.g. <%= var %>).
+Create a RAILS/config/locales/en.js.yml file
+  # Javascript translations
+  en:
+    welcome: 'Welcome'
+Create a configuration file RAILS/config/js_erb.yml
+  # Source paths
+  path:
+    views: app/views
+    source: app/javascripts
+    compiled: public/javascripts/compiled
+    locales: config/locales
+  # List of Haml, ERB or HTML files (base on path.source path)
+  views:
+    - users/_user.html.haml
+    - users/_line.html.erb
+You have to change the views list of the configuration file. Note also you can use ruby code
+inside the yml file (e.g. <%= var %>).
+At the end set javascript_include_tag (add javascript files into the <head>).
+== JsErb with Jammit
+Best practice is to use a packager to optimize project's javascript and stylesheets. You can
+easily connect JsErb plugin with {Jammit}[http://documentcloud.github.com/jammit/] assets
+packager. To integrate JsErb with Jammit you simply define JsErb's generated compiled files
+(at RAILS/public/javascripts/compiled) in to Jammit's assets.yml file.
+== JsErb caching
+The plugin will always compile files in the development or testing environment. In other
+environments (e.g. production) it will compile files only if the compiled directory is
+not present.

data/Rakefile ADDED Viewed

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+desc 'Default: run unit tests.'
+task :default => :test
+desc 'Test the comp_js plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+desc 'Generate documentation for the comp_js plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JsErb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/js_erb/controller.rb ADDED Viewed

@@ -0,0 +1,104 @@
+module JsErb
+  class Controller < ActionView::Base
+    #
+    # Runs the compile process.
+    #
+    def compile!
+      if defined?(Rails)
+        if (Rails.env.development? || Rails.env.test? || !File.exists?(JsErb.config['path']['compiled']))
+          Rails.logger.info '[JsErb] Compiling javascript ...';
+          prepare_path
+          compile_source_files
+          compile_locales
+          compile_views
+          Rails.logger.info '[JsErb] Done!';
+          true
+        end
+      end
+    end
+    protected
+    #
+    # Enshures thath the directories exist.
+    #
+    def prepare_path
+      FileUtils.mkdir_p(JsErb.config['path']['source'])
+      FileUtils.mkdir_p(JsErb.config['path']['compiled'])
+      FileUtils.mkdir_p(File.join(JsErb.config['path']['compiled'], 'locales'))
+      FileUtils.mkdir_p(File.join(JsErb.config['path']['compiled'], 'views'))
+    end
+    #
+    # Renders app/javascripts.
+    #
+    def compile_source_files
+      Dir.glob("#{JsErb.config['path']['source']}/*.jserb").each do |file|
+        name = File.basename(file, '.jserb')
+        content = ERB.new(IO.read(file)).result
+        File.open("#{JsErb.config['path']['compiled']}/#{name}.js" , "wb") do |f|
+          f.write(content)
+        end
+      end
+      Dir.glob("#{JsErb.config['path']['source']}/*.js").each do |file|
+        FileUtils.cp(file, JsErb.config['path']['compiled'])
+      end
+    end
+    #
+    # Renders config/locales.
+    #
+    def compile_locales
+      Dir.glob("#{JsErb.config['path']['locales']}/*.js.yml").each do |file|
+        name = File.basename(file, '.js.yml')
+        content = YAML.load(ERB.new(File.read(file)).result).to_json
+        File.open(File.join(JsErb.config['path']['compiled'], 'locales', "#{name}.js"), "wb") do |f|
+          f.write("var i18n = #{content};")
+        end
+      end
+    end
+    #
+    # Renders app/views.
+    #
+    def compile_views
+      helper = ActionView::Base.new
+      list = {}
+      JsErb.config['views'].each do |file|
+        ext = File.extname(file)
+        source = File.read(File.join(JsErb.config['path']['views'], file))
+        key = path_key(file)
+        case ext.downcase
+          when '.haml'
+            list[key] = Haml::Engine.new(source).render(helper)
+          when '.erb'
+            list[key] = ERB.new(source).result(binding)
+          else
+            list[key] = source
+        end
+      end
+      File.open(File.join(JsErb.config['path']['compiled'], 'views', 'jserb.js'), "wb") do |f|
+        f.write("var jserb = #{list.to_json};")
+      end
+    end
+    #
+    # Return the path as a key.
+    #
+    def path_key(file)
+      ext = File.extname(file)
+      key = file[0..-ext.length-1]
+      key = key.split(/\/|\\/).join('.').gsub('._', '.')
+      ext = File.extname(key)
+      key = key[0..-ext.length-1] if ext == '.html'
+      key
+    end
+  end
+end

data/lib/js_erb/version.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module JsErb
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/js_erb.rb ADDED Viewed

@@ -0,0 +1,29 @@
+module JsErb
+  mattr_accessor :config
+  #
+  # Runs the compile process.
+  #
+  def self.compile!
+    self.config = YAML.load(ERB.new(File.read(File.join(Rails.root, 'config', 'js_erb.yml'))).result)
+    JsErb::Controller.new.compile!
+  end
+end
+#
+# Load dependencies
+#
+%w( js_erb/controller
+    js_erb/version
+).each do |lib|
+    require File.join(File.dirname(__FILE__), lib)
+end
+#
+# This will add a before_filter to the ActionController which will
+# run the compile process.
+#
+ActionController::Base.class_eval do
+  append_before_filter { JsErb.compile! }
+end

data/test/js_erb_test.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'test_helper'
+class JsErbTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

metadata ADDED Viewed

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: js_erb
+version: !ruby/object:Gem::Version
+  hash: 27
+  prerelease: false
+  segments:
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors:
+- Kristijan Sedlak
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-11-05 00:00:00 +01:00
+default_executable:
+dependencies: []
+description: Javascript should be located under the RAILS/app directory instead of RAILS/public. Javascript usually produces at least a small piece of HTML code thus the Javascript templating is needed. Sites also require translations. Finally there are cases when you really need to put some ruby code into javascript. These are the features of the JsErb plugin.
+email: xpepermint@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- MIT-LICENSE
+- CHANGELOG.rdoc
+files:
+- Rakefile
+- lib/js_erb/controller.rb
+- lib/js_erb/version.rb
+- lib/js_erb.rb
+- test/js_erb_test.rb
+- test/test_helper.rb
+- README.rdoc
+- MIT-LICENSE
+- CHANGELOG.rdoc
+has_rdoc: true
+homepage: http://github.com/xpepermint/js_erb
+licenses: []
+post_install_message:
+rdoc_options:
+- --main
+- README.rdoc
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: JsErb - Javascript renderer for Ruby on Rails.
+test_files: []

js_erb 0.1.0