lucy 0.2.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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

@@ -0,0 +1,18 @@
+Lucy
+====
+
+Lucy in the sky with rubies.
+
+
+Example
+=======
+
+#Ruby
+Lucy.generate("horses", [{:name => "Gone with the Wind", :color => "Blue"}, {:name => "Powerade Powell", :color => "Pink"}]);
+
+//JS
+Lucy.horses[0].name
+=> "Gone with the Wind"
+
+
+Copyright (c) 2008 Tore Darell, released under the MIT license

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the lucy 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 lucy plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Lucy'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification. See http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "lucy"
+  gem.homepage = "http://github.com/toretore/lucy"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails plugin for generating javascript files from Ruby objects}
+  gem.description = gem.summary
+  gem.email = ""
+  gem.authors = ["Tore Darell"]
+  gem.add_development_dependency 'activesupport'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/init.rb

@@ -0,0 +1,2 @@
+require "lucy"
+require "lucy/common"

data/lib/lucy.rb

@@ -0,0 +1,76 @@
+module Lucy
+
+  DEFAULT_NAMESPACE = "Lucy"
+  DEFAULT_GLOBAL = "window"
+
+  def self.javascript_dir
+    @js_dir ||= File.join(Rails.root, "public", "javascripts")
+  end
+
+  def self.generate(key, content=nil, path=nil)
+    File.open(path || File.join(javascript_dir, "#{key}.js"), "w") do |f|
+      g = JavascriptGenerator.new
+      if block_given?
+        yield g
+      else
+        g.write key, content
+      end
+      f.write g.to_js
+    end
+  end
+
+  def self.file(src_path, dest_path=nil)
+    File.cp(src_path, dest_path || javascript_dir)
+  end
+
+
+  class JavascriptGenerator
+
+    attr_writer :namespace, :global, :init_namespace
+
+    def initialize
+      @keyed = []
+      @raw = []
+      yield self if block_given?
+    end
+
+    def write(key, obj)
+      @keyed << [key, ActiveSupport::JSON.encode(obj)]
+    end
+    alias []= write
+
+    def write_raw(data)
+      @raw << data
+    end
+    alias << write_raw
+
+    def to_a
+      (init_namespace? ? [init_namespace] : []) + @keyed.map do |key, value|
+        "#{namespace}.#{[key].flatten.join('.')} = #{value};"
+      end + @raw
+    end
+
+    def to_js
+      to_a.join("\n\n")
+    end
+
+    def namespace
+      @namespace || DEFAULT_NAMESPACE
+    end
+
+    def global
+      @global || DEFAULT_GLOBAL
+    end
+
+    def init_namespace
+      "if (!#{global}.#{namespace}) { #{namespace} = {}; }"
+    end
+
+    def init_namespace?
+      @init_namespace.nil? ? true : @init_namespace
+    end
+
+  end
+
+
+end

data/lib/lucy/common.rb

@@ -0,0 +1,25 @@
+module Lucy
+  module Common
+
+  def self.included(controller)
+    controller.send(:before_filter, :generate_common_javascript)
+  end
+
+  private
+
+    def generate_common_javascript
+      unless Rails.env.production? && Thread.current[:common_javascript_generated]
+        Lucy.generate "common" do |g|
+          g.namespace = "Rails"
+          g[:authenticityToken] = protect_against_forgery? ? form_authenticity_token : nil
+          g[:env] = Rails.env
+          g[:version] = Rails.version
+        end
+        Thread.current[:common_javascript_generated] = true
+      end
+    end
+
+  end
+end
+
+ActionController::Base.send(:include, Lucy::Common)

data/lib/tasks/lucy_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lucy do
+#   # Task goes here
+# end

data/test/lucy_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+class LucyTest < Test::Unit::TestCase
+
+  KEY = 'test'
+  PATH = File.join(File.dirname(__FILE__), 'test.js')
+  CONTENT = {:foo => "bar", :bar => {:ponies => true}, :numbers => [1,2,3]}
+
+  def test_generate_should_generate_file
+    Lucy.generate(KEY, CONTENT, PATH)
+    assert File.exists?(PATH)
+  end
+
+  def test_generate_should_yield_generator
+    generator = nil
+    Lucy.generate(KEY,CONTENT,PATH){|g| generator = g }
+    assert_not_nil generator
+    assert generator.is_a?(Lucy::JavascriptGenerator)
+  end
+
+  def test_generate_should_write_file_after_block_returns
+    content = nil
+    Lucy.generate KEY, nil, PATH do |g|
+      g.init_namespace = false
+      g.namespace = "Test"
+      g[:foo] = "humbaba"
+      content = g.to_js
+    end
+    assert_equal content, File.read(PATH)
+  end
+
+  def teardown
+    File.unlink(PATH) if File.exists?(PATH)
+  end
+
+end
+
+
+class JavascriptGeneratorTest < Test::Unit::TestCase
+
+  GLOBAL = 'test'
+  NAMESPACE = 'Test'
+  NAMESPACE_INIT = "if (!#{GLOBAL}.#{NAMESPACE}) { #{NAMESPACE} = {}; }"
+  NAMED = {:foo => "bar", :bar => {:ponies => true}, :numbers => [1,2,3]}
+  NAMED_EXPECTED = NAMED.map{|k,v| "#{NAMESPACE}.#{k} = #{ActiveSupport::JSON.encode(v)};" }
+  RAW = "function humbaba(){ alert('Whatcha doin in my forest?'); };"
+  EXPECTED_OUTPUT = ([NAMESPACE_INIT]+NAMED_EXPECTED+[RAW]).join("\n\n")
+
+  def setup
+    @generator = Lucy::JavascriptGenerator.new
+    @generator.global = GLOBAL
+    @generator.namespace = NAMESPACE
+    NAMED.each{|k,v| @generator[k] = v }
+    @generator << RAW
+  end
+
+  def test_should_include_init_namespace_by_default
+    assert_equal NAMESPACE_INIT, @generator.to_a.first
+  end
+
+  def test_should_not_include_init_namespace_when_told_not_to
+    @generator.init_namespace = false
+    assert_not_equal NAMESPACE_INIT, @generator.to_a.first
+  end
+
+  def test_should_generate_properties_added_by_write
+    assert_equal NAMED_EXPECTED, @generator.to_a[1,3]
+  end
+
+  def test_should_add_raw
+    assert_equal RAW, @generator.to_a.last
+  end
+
+  def test_should_concatenate_named_and_raw_with_to_js
+    assert_equal EXPECTED_OUTPUT, @generator.to_js
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'active_support'
+require 'test/unit'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'lucy')

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: lucy
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Tore Darell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Rails plugin for generating javascript files from Ruby objects
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/lucy.rb
+- lib/lucy/common.rb
+- lib/tasks/lucy_tasks.rake
+- test/lucy_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/toretore/lucy
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: Rails plugin for generating javascript files from Ruby objects
+test_files: 
+- test/lucy_test.rb
+- test/test_helper.rb