bitcharts 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f14bd700fdacea816584879122138ce39eab28e6
-  data.tar.gz: e9adbde0b4e13535a51083e613708062fb732283
+  metadata.gz: ffa0c3419f3193fcc1a82ddaaaec263147a861ae
+  data.tar.gz: c896ef9f22a8805ba2cf3dae45fbdc4681d6a543
 SHA512:
-  metadata.gz: 98f971f160b30396f351098aff05135974cb7d758e2a831982341fbf1dd857f9afb79e98ebbc368cba0b86b4620eec66fe3dcd8c8ad812f0340da96d8f5b958d
-  data.tar.gz: 40f99d134023f652d2a1a09883c931c7369a3d08402c6c8f63347e27de3c425b7ef1af02b7dcde3a5ce7324cf1c4dd1375b8b0899e9a0ddbbfe28edb6bc4ea6a
+  metadata.gz: 477dedeedca6777d798eea4b9d14614b074c3ac94d3baf156d0e83b4e2d6535edf1b12fda135be662b84043bfad390415ebc8e5f4f4bb3b7eb2ad7a9a742495c
+  data.tar.gz: 36aabcbecaa467d7e3ce4034581ff018ea15552c33ad33784cf08f30ce2659bc59712af8a95828c3035f19a84ffd41516cc17814d0cfdd5510b5f19650d595a7

data/README.rdoc

@@ -1,19 +1,35 @@
-= Bitcharts =
+= Bitcharts
 
-== Usage ==
+== Usage
 
-1. Generate a chart
+=== Mount Engine in +routes.rb+
 
-~~~
-rails g bitcharts:chart user_logins
-# or a scoped chart:
-rails g bitcharts:scoped_chart user_logins
-~~~
+  mount Bitcharts::Engine => "/bitcharts"
 
-2. Implement chart's value method in `app/charts/user_logins_chart.rb`
-3. Include canvas into your view
+=== Generate a chart
 
-~~~
-<%= bitchart 'user_logins', from: 7.days.ago, to: Date.today %>
-<%# Check Bitcharts::ApplicationHelper for more options %>
-~~~
+  rails g bitcharts:chart user_logins
+  # or a scoped chart:
+  rails g bitcharts:scoped_chart user_logins
+
+=== Implement chart's value method 
+
+Change the generated method in +app/charts/user_logins_chart.rb+:
+
+  def value(date_range)
+    User::Login.where(created_at: date_range).count
+  end
+
+=== Add canvas to your view
+
+  <%= bitchart 'user_logins', from: 7.days.ago, to: Date.today %>
+
+Check +Bitcharts::ApplicationHelper+ for all available options.
+
+=== Add Javascript
+
+Require Javascript in your applications Javascript or load it dynamically in your view when needed:
+
+  <%= javascript_include_tag 'bitcharts/default' %>
+
+If you don't use jQuery already use +bitcharts/full+ instead.

data/app/assets/javascripts/bitcharts/default.js.coffee

@@ -0,0 +1,2 @@
+#= require chart.min.js
+#= require bitcharts/init

data/app/assets/javascripts/bitcharts/full.js.coffee

@@ -0,0 +1,3 @@
+#= require jquery
+#= require chart.min.js
+#= require bitcharts/init

data/app/assets/javascripts/bitcharts/{application.js.coffee → init.js.coffee}

@@ -1,6 +1,3 @@
-#= require jquery
-#= require chart.min.js
-
 @Bitcharts = Bitcharts =
 
   defaultBorderWidth:  2

data/lib/bitcharts/engine.rb

@@ -4,6 +4,11 @@ module Bitcharts
     config.autoload_paths += %W(#{config.root}/app/charts)
     config.to_prepare do
       ::ApplicationController.helper(Bitcharts::ApplicationHelper)
+      Rails.application.config.assets.precompile += %w(
+        bitcharts/default.js
+        bitcharts/full.js
+        bitcharts/init.js
+      )
     end
   end
 end

data/lib/bitcharts/version.rb

@@ -1,3 +1,3 @@
 module Bitcharts
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitcharts
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sebastian Gaul
@@ -76,7 +76,9 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
-- app/assets/javascripts/bitcharts/application.js.coffee
+- app/assets/javascripts/bitcharts/default.js.coffee
+- app/assets/javascripts/bitcharts/full.js.coffee
+- app/assets/javascripts/bitcharts/init.js.coffee
 - app/assets/stylesheets/bitcharts/application.css
 - app/controllers/bitcharts/application_controller.rb
 - app/controllers/bitcharts/days_controller.rb