coffee-rails-source-maps 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in coffee-rails-source-maps.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Mark Bates
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,49 @@
1
+ # CoffeeScript Rails Source Maps
2
+
3
+ Adds CoffeeScript source maps support, introduced in version [1.6.1](http://coffeescript.org/#changelog), to Rails. This code is based on a Gist by [naan](https://gist.github.com/naan/5096056).
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'coffee-rails-source-maps'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ ## Usage
16
+
17
+ This gem should really only be used in development mode.
18
+
19
+ ```ruby
20
+ group :development do
21
+ gem 'coffee-rails-source-maps'
22
+ end
23
+ ```
24
+
25
+ This gem will create a folder called `source_maps` in the Rails `public` directory. I would recommend adding this to your `.gitignore` file so you don't check this folder into git.
26
+
27
+ ```
28
+ public/source_maps/
29
+ ```
30
+
31
+ ### Using Source Maps in Chrome
32
+
33
+ In order to use the source maps you need to use a browser that supports them. Chrome is an excellent choice.
34
+
35
+ Open the Chrome console and click on the settings tab. You'll see an option to enable source maps, make sure that is checked.
36
+
37
+ ![](http://i.imgur.com/5ndSqZV.jpg)
38
+
39
+ ### Activating the Map
40
+
41
+ Finally to see your CoffeeScript code in the Chrome console just add a `debugger` call in your code and you'll see the CoffeeScript in your console to debug.
42
+
43
+ ## Contributing
44
+
45
+ 1. Fork it
46
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
47
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
48
+ 4. Push to the branch (`git push origin my-new-feature`)
49
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,23 @@
1
+ # -*- encoding: utf-8 -*-
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'coffee-rails-source-maps/version'
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = "coffee-rails-source-maps"
8
+ gem.version = CoffeeRailsSourceMaps::VERSION
9
+ gem.authors = ["Mark Bates"]
10
+ gem.email = ["mark@markbates.com"]
11
+ gem.description = %q{Adds support to Rails for CoffeeScript Source Maps}
12
+ gem.summary = %q{Adds support to Rails for CoffeeScript Source Maps}
13
+ gem.homepage = ""
14
+ gem.license = "MIT"
15
+
16
+ gem.files = `git ls-files`.split($/)
17
+ gem.executables = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
19
+ gem.require_paths = ["lib"]
20
+
21
+ gem.add_dependency("coffee-script-source", ">= 1.6.1")
22
+ gem.add_development_dependency "rake"
23
+ end
@@ -0,0 +1,55 @@
1
+ require "coffee-rails-source-maps/version"
2
+
3
+ # Based on https://gist.github.com/naan/5096056
4
+ # config/initializers/source_maps.rb
5
+
6
+ if Rails.env.development?
7
+ module CoffeeScript
8
+
9
+ class << self
10
+
11
+ def compile(script, options = {})
12
+ script = script.read if script.respond_to?(:read)
13
+
14
+ if options.key?(:no_wrap) && !options.key?(:bare)
15
+ options[:bare] = options[:no_wrap]
16
+ else
17
+ options[:bare] = false
18
+ end
19
+
20
+ # adding source maps option. (source maps option requires filename option.)
21
+ options[:sourceMap] = true
22
+ options[:filename] = options[:pathname].basename.to_s
23
+
24
+ ret = Source.context.call("CoffeeScript.compile", script, options)
25
+
26
+ map_dir = Rails.root.join("public/source_maps")
27
+ map_dir.mkpath
28
+
29
+ basename = options[:pathname].basename('.coffee')
30
+ map_file = map_dir.join("#{basename}.map")
31
+ coffee_file = map_dir.join("#{basename}.coffee")
32
+
33
+ coffee_file.open('w') {|f| f.puts script }
34
+ map_file.open('w') {|f| f.puts ret["v3SourceMap"]}
35
+
36
+ comment = "//@ sourceMappingURL=/source_maps/#{map_file.basename}\n"
37
+ return comment + ret["js"]
38
+
39
+ end
40
+
41
+ end
42
+ end
43
+
44
+ # Monkeypatch this method to include the scripts' pathname
45
+ require 'tilt/template'
46
+
47
+ module Tilt
48
+ class CoffeeScriptTemplate < Template
49
+ def evaluate(scope, locals, &block)
50
+ @output ||= CoffeeScript.compile(data, options.merge(pathname: scope.pathname))
51
+ end
52
+ end
53
+ end
54
+
55
+ end
@@ -0,0 +1,3 @@
1
+ module CoffeeRailsSourceMaps
2
+ VERSION = "1.0.0"
3
+ end
metadata ADDED
@@ -0,0 +1,93 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: coffee-rails-source-maps
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Mark Bates
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-03-07 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: coffee-script-source
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: 1.6.1
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ! '>='
28
+ - !ruby/object:Gem::Version
29
+ version: 1.6.1
30
+ - !ruby/object:Gem::Dependency
31
+ name: rake
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ! '>='
36
+ - !ruby/object:Gem::Version
37
+ version: '0'
38
+ type: :development
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ! '>='
44
+ - !ruby/object:Gem::Version
45
+ version: '0'
46
+ description: Adds support to Rails for CoffeeScript Source Maps
47
+ email:
48
+ - mark@markbates.com
49
+ executables: []
50
+ extensions: []
51
+ extra_rdoc_files: []
52
+ files:
53
+ - .gitignore
54
+ - .rspec
55
+ - Gemfile
56
+ - LICENSE.txt
57
+ - README.md
58
+ - Rakefile
59
+ - coffee-rails-source-maps.gemspec
60
+ - lib/coffee-rails-source-maps.rb
61
+ - lib/coffee-rails-source-maps/version.rb
62
+ homepage: ''
63
+ licenses:
64
+ - MIT
65
+ post_install_message:
66
+ rdoc_options: []
67
+ require_paths:
68
+ - lib
69
+ required_ruby_version: !ruby/object:Gem::Requirement
70
+ none: false
71
+ requirements:
72
+ - - ! '>='
73
+ - !ruby/object:Gem::Version
74
+ version: '0'
75
+ segments:
76
+ - 0
77
+ hash: -552259071308065432
78
+ required_rubygems_version: !ruby/object:Gem::Requirement
79
+ none: false
80
+ requirements:
81
+ - - ! '>='
82
+ - !ruby/object:Gem::Version
83
+ version: '0'
84
+ segments:
85
+ - 0
86
+ hash: -552259071308065432
87
+ requirements: []
88
+ rubyforge_project:
89
+ rubygems_version: 1.8.25
90
+ signing_key:
91
+ specification_version: 3
92
+ summary: Adds support to Rails for CoffeeScript Source Maps
93
+ test_files: []