simple_d3 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92d77777b62827b1c7cd915e91fac778e9537da8
+  data.tar.gz: 6cde98228fa9f5360bc9ba0a483f0c4f7dae5c31
+SHA512:
+  metadata.gz: 8a9b92c49ec365d77d1603adf00da6393c6718464d17918cb34f6cdfa7b76d924bfe9acf8c4318807bb2a13be95581502502a35245c8cf8378987001ea90d4e8
+  data.tar.gz: ba06b0b90d38413d28d597aaa842817c8b9bca97a55845c4f29533cb1e6e0c6857270bf30743b800d85dca77b432dd2592916f271625ee39f65db921f7a27f11

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TigerWolf
+
+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,71 @@
+# SimpleD3
+
+Helps create simple D3 graphs quickly without much code.
+
+# Installation
+
+Add simple d3 to your gemfile
+
+``gem 'simple_d3'``
+
+Then add **d3** to your application.js
+
+```
+..
+//= require d3
+//= require_tree .
+```
+
+Then add this to your view:
+
+```
+<script type="text/javascript">
+  var data = [ 5, 10, 13, 19, 21, 25, 22, 18, 15, 13,
+          11, 12, 15, 20, 18, 17, 16, 18, 23, 25 ];
+</script>
+
+<%= simple_d3("my_chart") %>
+```
+
+### Bar Chart
+
+```
+<script type="text/javascript">
+  var data = [ 5, 10, 13, 19, 21, 25, 22, 18, 15, 13,
+          11, 12, 15, 20, 18, 17, 16, 18, 23, 25 ];
+</script>
+
+<%= simple_d3_bar("my_bars",:graph) %>
+```
+
+### Pie Chart
+
+```
+<script type="text/javascript">
+  var data = [ 5, 10, 20, 45, 6, 25 ];
+</script>
+
+<%= simple_d3_pie("my_pie",:pie) %>
+```
+
+### Setting Options
+
+You can also set options, like:
+
+```
+<%= simple_d3("my_pie3",{:type=>"pie", :width=> 1000, :height => 500}) %>
+```
+
+Current options are:
+```
+type - "bar" or "pie"
+width
+height
+colors - array of colors
+```
+
+See https://github.com/TigerWolf/simple_d3_demo for more examples.
+
+### Screenshot
+
+![Screenshot](docs/demo.png?raw=true "Optional Title" =450x)

data/Rakefile

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

data/TODO.md

@@ -0,0 +1,11 @@
+TODO & Ideas
+===
+
+Just a list of potential future additions to this gem.
+
+ * Overwriting of templates with a view
+ * Custom Additions/Modification to javascript
+ * Allow for data to be defined in controller i_var or similar
+ * Load data dynamically from a "live call" (Call to controller to get json data from AR model)
+ * Tests
+ * More color scales and easy "named" color settings

data/lib/simple_d3.rb

@@ -0,0 +1,10 @@
+require "simple_d3/version"
+require "simple_d3/template"
+require "simple_d3/layout_helper"
+
+module SimpleD3
+
+end
+
+# lib/my_gem.rb
+require 'simple_d3/engine' if defined?(Rails)

data/lib/simple_d3/engine.rb

@@ -0,0 +1,5 @@
+module SimpleD3
+  class Engine < ::Rails::Engine
+    require 'd3_rails'
+  end
+end

data/lib/simple_d3/layout_helper.rb

@@ -0,0 +1,38 @@
+module SimpleD3
+  module LayoutHelper
+    include ActionView::Helpers::TagHelper
+    def simple_d3(placeholder, settings={})
+      defaults = {
+        :type    => :bar,
+        :width    => 600,
+        :height   => 250,
+      }
+      settings.reverse_merge!(defaults)
+      graph = SimpleD3::Template.template(placeholder, settings).prepend(content_tag("div", "", {id: placeholder}))
+
+      # Display without escaping html
+      if defined?(raw)
+        return raw(graph)
+      else
+        return graph
+      end
+
+    end
+
+    def simple_d3_bar(placeholder, settings={})
+      settings[:type] = "bar"
+      settings[:width] = 600
+      settings[:height] = 250
+      settings[:colors] = ["#deebf7","#c6dbef","#9ecae1","#6baed6","#4292c6","#2171b5","#08519c","#08306b"]
+      simple_d3(placeholder, settings)
+    end
+
+    def simple_d3_pie(placeholder, settings={})
+      settings[:type] = "pie"
+      settings[:width] = settings[:height] = 500
+      simple_d3(placeholder, settings)
+    end
+  end
+end
+
+ActionView::Base.send :include, SimpleD3::LayoutHelper

data/lib/simple_d3/template.rb

@@ -0,0 +1,142 @@
+module SimpleD3
+  class Template
+    def self.template(placeholder, settings)
+      template = new(placeholder, settings)
+      javascript = template.send(settings[:type])
+      colors = settings[:colors].present? ? template.colors(settings[:colors]) : "d3.scale.category10()"
+      
+      graph = <<-EOJS
+      <script type="text/javascript">
+        //Width and height
+        var w = #{settings[:width]};
+        var h = #{settings[:height]};
+
+        //Easy colors accessible via a 10-step ordinal scale
+        var colors = #{colors};
+
+        #{javascript}
+      </script>
+      EOJS
+    end
+
+    def initialize(placeholder, settings)
+      @placeholder = placeholder
+      @settings = settings
+    end
+
+    def colors(color_array)
+      colors = <<-EOJS
+        d3.scale.ordinal()
+          .range(#{color_array.to_s})
+          .domain(d3.range(0,#{color_array.size}))
+      EOJS
+    end
+
+    def bar
+      graph = <<-EOJS
+
+        var xScale = d3.scale.ordinal()
+                .domain(d3.range(data.length))
+                .rangeRoundBands([0, w], 0.05);
+
+        var yScale = d3.scale.linear()
+                .domain([0, d3.max(data)])
+                .range([0, h]);
+
+        //Create SVG element
+        var #{@placeholder} = d3.select("##{@placeholder}")
+              .append("svg")
+              .attr("width", w)
+              .attr("height", h);
+
+        //Create bars
+        #{@placeholder}.selectAll("rect")
+           .data(data)
+           .enter()
+           .append("rect")
+           .attr("x", function(d, i) {
+              return xScale(i);
+           })
+           .attr("y", function(d) {
+              return h - yScale(d);
+           })
+           .attr("width", xScale.rangeBand())
+           .attr("height", function(d) {
+              return yScale(d);
+           })
+           .attr("fill", function(d, i) {
+              return colors(i);
+            })
+           .on("mouseover", function(d) {
+
+            //Get this bar's x/y values, then augment for the tooltip
+            var xPosition = parseFloat(d3.select(this).attr("x")) + xScale.rangeBand() / 2;
+            var yPosition = parseFloat(d3.select(this).attr("y")) + 14;
+
+            //Create the tooltip label
+            #{@placeholder}.append("text")
+               .attr("id", "tooltip")
+               .attr("x", xPosition)
+               .attr("y", yPosition)
+               .attr("text-anchor", "middle")
+               .attr("font-family", "sans-serif")
+               .attr("font-size", "11px")
+               .attr("font-weight", "bold")
+               .attr("fill", "black")
+               .text(d);
+
+           })
+           .on("mouseout", function() {
+
+            //Remove the tooltip
+            d3.select("#tooltip").remove();
+
+           });
+
+      EOJS
+    end
+
+    def pie
+      pie = <<-EOJS
+        var outerRadius = w / 2;
+        var innerRadius = 0;
+        var arc = d3.svg.arc()
+                .innerRadius(innerRadius)
+                .outerRadius(outerRadius);
+
+        var pie = d3.layout.pie();
+
+        //Create SVG element
+        var #{@placeholder} = d3.select("##{@placeholder}")
+              .append("svg")
+              .attr("width", w)
+              .attr("height", h);
+
+        //Set up groups
+        var arcs = #{@placeholder}.selectAll("g.arc")
+                .data(pie(data))
+                .enter()
+                .append("g")
+                .attr("class", "arc")
+                .attr("transform", "translate(" + outerRadius + "," + outerRadius + ")");
+
+        //Draw arc paths
+        arcs.append("path")
+            .attr("fill", function(d, i) {
+              return colors(i);
+            })
+            .attr("d", arc);
+
+        //Labels
+        arcs.append("text")
+            .attr("transform", function(d) {
+              return "translate(" + arc.centroid(d) + ")";
+            })
+            .attr("text-anchor", "middle")
+            .text(function(d) {
+              return d.value;
+        });
+      EOJS
+    end
+  end
+end

data/lib/simple_d3/version.rb

@@ -0,0 +1,3 @@
+module SimpleD3
+  VERSION = "0.0.1"
+end

data/simple_d3.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_d3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_d3"
+  spec.version       = SimpleD3::VERSION
+  spec.authors       = ["TigerWolf"]
+  spec.email         = ["hiddentiger@gmail.com"]
+  spec.summary       = %q{Simple graphs with D3 in Rails}
+  spec.description   = %q{Make simple graphs with D3 in your rails project.}
+  spec.homepage      = "https://github.com/TigerWolf/simple_d3"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'd3_rails', '~> 3.4.9'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: simple_d3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- TigerWolf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: d3_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make simple graphs with D3 in your rails project.
+email:
+- hiddentiger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- docs/demo.png
+- lib/simple_d3.rb
+- lib/simple_d3/engine.rb
+- lib/simple_d3/layout_helper.rb
+- lib/simple_d3/template.rb
+- lib/simple_d3/version.rb
+- simple_d3.gemspec
+homepage: https://github.com/TigerWolf/simple_d3
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple graphs with D3 in Rails
+test_files: []