rickshaw_rails 0.0.1 → 0.0.2
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/README.md +33 -4
- data/lib/rickshaw_rails/version.rb +1 -1
- data/rickshaw_rails.gemspec +2 -2
- data/vendor/assets/javascripts/rickshaw_rails.js +1 -0
- metadata +9 -8
data/README.md
CHANGED
|
@@ -1,6 +1,14 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Rickshaw
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Rickshaw is a JavaScript toolkit for creating interactive time series graphs, developed at Shutterstock, and uses the d3 data visualization javascript framework
|
|
4
|
+
|
|
5
|
+
# About D3
|
|
6
|
+
|
|
7
|
+
**D3** is a small, free JavaScript library for manipulating HTML documents
|
|
8
|
+
based on data. D3 can help you quickly visualize your data as HTML or SVG,
|
|
9
|
+
handle interactivity, and incorporate smooth transitions and staged animations
|
|
10
|
+
into your pages. You can use D3 as a visualization framework (like Protovis),
|
|
11
|
+
or you can use it to build dynamic pages (like jQuery).
|
|
4
12
|
|
|
5
13
|
## Installation
|
|
6
14
|
|
|
@@ -15,10 +23,31 @@ And then execute:
|
|
|
15
23
|
Or install it yourself as:
|
|
16
24
|
|
|
17
25
|
$ gem install rickshaw_rails
|
|
26
|
+
# Usage
|
|
27
|
+
|
|
28
|
+
All you have to do is include the desired files in your application.js (or another manifest file), like so:
|
|
29
|
+
|
|
30
|
+
//= require rickshaw
|
|
31
|
+
|
|
32
|
+
And similarly with your css manifest (application.css):
|
|
33
|
+
|
|
34
|
+
/*
|
|
35
|
+
*= require rickshaw
|
|
36
|
+
*/
|
|
37
|
+
|
|
38
|
+
# Additional Files
|
|
39
|
+
|
|
40
|
+
I have, for your convenience, thrown d3 (version 2.9.1, I think), into the vendor file, so if you're not using [d3_rails](https://github.com/logical42/d3_rails), then you can either require d3 directly (but before rickshaw) in your manifest:
|
|
41
|
+
|
|
42
|
+
//= require d3.v2
|
|
43
|
+
//= require rickshaw
|
|
44
|
+
|
|
45
|
+
Or you can just use the manifest file which I threw in here:
|
|
46
|
+
|
|
47
|
+
//= require rickshaw_with_d3
|
|
18
48
|
|
|
19
|
-
|
|
49
|
+
and that should include both d3 and rickshaw into you javascripts in the correct order.
|
|
20
50
|
|
|
21
|
-
TODO: Write usage instructions here
|
|
22
51
|
|
|
23
52
|
## Contributing
|
|
24
53
|
|
data/rickshaw_rails.gemspec
CHANGED
|
@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
|
|
|
6
6
|
s.email = ["han@logicallsat.com"]
|
|
7
7
|
s.description = %q{ Rickshaw, a javascript graphing library based on d3, for the rails asset pipeline }
|
|
8
8
|
s.summary = %q{ Gem installation of javascript framework for data visualization, D3 }
|
|
9
|
-
s.homepage = "https://github.com/logical42/
|
|
9
|
+
s.homepage = "https://github.com/logical42/rickshaw_railsgi"
|
|
10
10
|
s.files = `git ls-files`.split("\n")
|
|
11
11
|
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
|
12
12
|
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
|
@@ -16,6 +16,6 @@ Gem::Specification.new do |s|
|
|
|
16
16
|
s.add_development_dependency "bundler", "~> 1.0.0"
|
|
17
17
|
s.add_development_dependency "rails", "~> 3.1"
|
|
18
18
|
s.name = "rickshaw_rails"
|
|
19
|
-
s.version = "0.0.
|
|
19
|
+
s.version = "0.0.2"
|
|
20
20
|
end
|
|
21
21
|
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
//= require_self
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: rickshaw_rails
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.2
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -16,7 +16,7 @@ date: 2012-05-09 00:00:00.000000000Z
|
|
|
16
16
|
dependencies:
|
|
17
17
|
- !ruby/object:Gem::Dependency
|
|
18
18
|
name: railties
|
|
19
|
-
requirement: &
|
|
19
|
+
requirement: &70301121634040 !ruby/object:Gem::Requirement
|
|
20
20
|
none: false
|
|
21
21
|
requirements:
|
|
22
22
|
- - ! '>='
|
|
@@ -24,10 +24,10 @@ dependencies:
|
|
|
24
24
|
version: 3.1.0
|
|
25
25
|
type: :runtime
|
|
26
26
|
prerelease: false
|
|
27
|
-
version_requirements: *
|
|
27
|
+
version_requirements: *70301121634040
|
|
28
28
|
- !ruby/object:Gem::Dependency
|
|
29
29
|
name: bundler
|
|
30
|
-
requirement: &
|
|
30
|
+
requirement: &70301121633540 !ruby/object:Gem::Requirement
|
|
31
31
|
none: false
|
|
32
32
|
requirements:
|
|
33
33
|
- - ~>
|
|
@@ -35,10 +35,10 @@ dependencies:
|
|
|
35
35
|
version: 1.0.0
|
|
36
36
|
type: :development
|
|
37
37
|
prerelease: false
|
|
38
|
-
version_requirements: *
|
|
38
|
+
version_requirements: *70301121633540
|
|
39
39
|
- !ruby/object:Gem::Dependency
|
|
40
40
|
name: rails
|
|
41
|
-
requirement: &
|
|
41
|
+
requirement: &70301121633080 !ruby/object:Gem::Requirement
|
|
42
42
|
none: false
|
|
43
43
|
requirements:
|
|
44
44
|
- - ~>
|
|
@@ -46,7 +46,7 @@ dependencies:
|
|
|
46
46
|
version: '3.1'
|
|
47
47
|
type: :development
|
|
48
48
|
prerelease: false
|
|
49
|
-
version_requirements: *
|
|
49
|
+
version_requirements: *70301121633080
|
|
50
50
|
description: ! ' Rickshaw, a javascript graphing library based on d3, for the rails
|
|
51
51
|
asset pipeline '
|
|
52
52
|
email:
|
|
@@ -66,9 +66,10 @@ files:
|
|
|
66
66
|
- rickshaw_rails.gemspec
|
|
67
67
|
- vendor/assets/javascripts/d3.v2.js
|
|
68
68
|
- vendor/assets/javascripts/rickshaw.js
|
|
69
|
+
- vendor/assets/javascripts/rickshaw_rails.js
|
|
69
70
|
- vendor/assets/javascripts/rickshaw_with_d3.js
|
|
70
71
|
- vendor/assets/stylesheets/rickshaw.css
|
|
71
|
-
homepage: https://github.com/logical42/
|
|
72
|
+
homepage: https://github.com/logical42/rickshaw_railsgi
|
|
72
73
|
licenses: []
|
|
73
74
|
post_install_message:
|
|
74
75
|
rdoc_options: []
|