technical_graph 0.5.1 → 0.6.0

data/Gemfile

@@ -1,11 +1,32 @@
+# hack for loading gems if they were are available to add
+# some optional features
+def gem_available?(name)
+   Gem::Specification.find_by_name(name)
+rescue Gem::LoadError
+   false
+rescue
+   Gem.available?(name)
+end
+
+
 source "http://rubygems.org"
 
+# SVG
 gem 'rasem'
 
-# optional gem
-if Gem.source_index.find_name('rmagick').size > 0
-  gem 'rmagick'
-end
+# PNG
+gem 'chunky_png'
+gem 'rmagick' if gem_available? 'rmagick'
+gem 'oily_png' if gem_available? 'oily_png'
+
+# optional gem - creating graphs using ImageMagic
+#if Gem.source_index.find_name('rmagick').size > 0
+#  gem 'rmagick'
+#end
+# optional gem - chunky_png C addon
+#if Gem.source_index.find_name('oily_png').size > 0
+#  gem 'oily_png'
+#end
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -15,5 +36,5 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "rspec"
   gem "jeweler" #, "~> 1.6.4"
-  gem "rcov", ">= 0"
+  gem "simplecov", ">= 0"
 end

data/Gemfile.lock

@@ -1,36 +1,52 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    chunky_png (1.2.5)
     diff-lcs (1.1.3)
     git (1.2.5)
-    jeweler (1.6.4)
+    jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.6.1)
+      rdoc
+    json (1.7.3)
+    multi_json (1.3.5)
+    oily_png (1.0.2)
+      chunky_png (~> 1.2.1)
     rake (0.9.2.2)
     rasem (0.6.1)
-    rcov (0.9.11)
-    rdoc (3.11)
+    rdoc (3.12)
       json (~> 1.4)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
-    shoulda (2.11.3)
+    rmagick (2.13.1)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  chunky_png
   jeweler
+  oily_png
   rasem
-  rcov
   rdoc
+  rmagick
   rspec
   shoulda
+  simplecov

data/README.md

@@ -3,83 +3,113 @@ technical_graph
 
 Purpose of this gem is to create neat, meaningful, linear graphs for large amount of data.
 
-If you want to:
-
-* create big graphs using large amount of data,
-* do it offline,
+When you want to:
+* create big graph using large amount of data,
+* do it offline and speed is not the most important factor,
 * minimize needed code,
 * use only linear graph,
-* speed is not essential,
 * RMagick / ImageMagick is ok for you,
 * tired of forgotten gems/libraries...
 
-then you should try this gem.
+Then you should try this gem.
 
 I created it because there were not available and maintained gems for that I needed. Now I use it to create hourly
-temperature and wind graphs for vast period of time (months, years), visualize measurements for [HomeIO](https://github.com/akwiatkowski/HomeIO).
-
-If you want to create candy, ultra fast, web graphs it maybe not the best tool. If you want other graph types than linear it
-is definitely not the right tool for you. It is also not SVG ready yet, but it should be within a few months.
-You can find my competitors [here](https://www.ruby-toolbox.com/categories/graphing).
+temperature and wind speed graphs for vast period of time (months, years), visualize measurements for [HomeIO](https://github.com/akwiatkowski/HomeIO).
 
+If you want to create candy, ultra fast, web graphs it is maybe not the best tool. If you want other graph types than linear it
+is definitely not the right tool for you. You can find my competitors [here](https://www.ruby-toolbox.com/categories/graphing).
 
 Future
 ------
 
-1. Finish data processors: smoothing (nearly done), noise removal (50%), interpolation or curved graphs (planned).
-2. Fix export to SVG.
-3. Optimization, and if needed find or write something faster for creating SVGs.
-
+1. Curved graphs.
+2. Bug fixes, cleaning.
 
 Quick start
 -----------
 
-Check currents test when documentation is not enough :)
+Check currents test if documentation is not enough :)
+
+* Create 'the instance'
+
+    > tg = TechnicalGraph.new
+
+    or
+
+    > tg = TechnicalGraph.new( options )
+
+    where:
+
+    + options - Hash of parameters, all parameters are described [here](https://github.com/akwiatkowski/technical_graph/blob/master/DOCUMENTATION.textile).
+
+* Add layer
+
+    > tg.add_layer(layer_data)
 
-1. Create instance
+    or
 
-> tg = TechnicalGraph.new
+    > tg.add_layer(layer_data, layer_params)
 
-or
+    where:
 
-> tg = TechnicalGraph.new( options )
+    + layer_data - Array of Hashes, like [{:x => 0, :y => 0}, {:x => 1, :y => 1}, ...]
+    + layer_params - Hash of other parameters, all parameters are described [here](https://github.com/akwiatkowski/technical_graph/blob/master/DOCUMENTATION.textile).
 
-where:
+* Save to file
 
-* options - Hash of parameters, all parameters are described below.
+    > tg.save_to_file('image.svg')
 
-2. Add layer
+    or
 
-> tg.add_layer(layer_data)
+    > tg.save_to_file('image.svgz')
 
-or
+    or
 
-> tg.add_layer(layer_data, layer_params)
+    > tg.save_to_file('image.png')
+
+
+    or get binary version of output using
+
+    > tg.to_format(format) # where format is 'svg', 'svgz', 'png', ...
+
+
+This is the new, easiest, better and nicer approach because technical_graph render graph
+using appropriate drawer to file extension.
+
+
+Some notes about formats and dependencies
+-----------------------------------------
+
+technical_graph uses [rasem](https://github.com/aseldawy/rasem) for SVG and it works wery well.
+For PNG it uses [chunky_png](https://github.com/wvanbergen/chunky_png) with [oily_png](https://github.com/wvanbergen/oily_png)
+if possible, but there is a lot of missing features. If you need PNG I recommend to install
+good, old [rmagick](https://github.com/rmagick/rmagick).
+
+
+An old way
+-------------
 
-where:
+Up to version 0.5.1 you had to render image before you could save it to file. It should work in current version too.
 
-* layer_data - Array of Hashes, like [{:x => 0, :y => 0}, {:x => 1, :y => 1}, ...]
-* layer_params - Hash of other parameters, all parameters are described later.
+* Render graph
 
-3. Render graph
+    > tg.render
 
-> tg.render
+* Save to file
 
-4. Save to file
+    > tg.image_drawer.save_to_file('image.png')
 
-> tg.image_drawer.save_to_file('image.png')
+    or get image binary content.
 
-or get image binary content.
+    > tg.image_drawer.to_format(format)
 
-> tg.image_drawer.to_format(format)
 
-where format is image format, ex. 'png', 'jpeg', ... Of course I prefer 'png'.
 
 
 Documentation
 -------------
 
-Documentation is moved [here](https://github.com/akwiatkowski/technical_graph/blob/master/DOCUMENTATION.textile)
+Documentation was moved [here](https://github.com/akwiatkowski/technical_graph/blob/master/DOCUMENTATION.textile)
 
 
 Contributing to technical-graph
@@ -99,6 +129,5 @@ Contributing to technical-graph
 Copyright
 ---------
 
-Copyright (c) 2011 Aleksander Kwiatkowski. See LICENSE.txt for
-further details.
+Copyright (c) 2011-2012 Aleksander Kwiatkowski. See LICENSE.txt for further details.
 

data/Rakefile

@@ -41,29 +41,31 @@ desc "Clean and release"
 task :clean_and_release => [:clean, :release] do
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :default => :test
+task :default => :spec
 
-require 'rdoc/task'
+require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "technical-graph #{version}"
+  rdoc.title = "gpx2exif #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "Run RSpec with code coverage"
+task :coverage do
+  `rake spec COVERAGE=true`
+  #`open coverage/index.html`
+end

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/technical_graph.rb

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'logger'
+require 'technical_graph/gem'
 require 'technical_graph/data_layer'
 require 'technical_graph/graph_data_processor'
 require 'technical_graph/graph_image_drawer'
@@ -71,4 +72,48 @@ class TechnicalGraph
     # draw legend
     @image_drawer.render_data_legend
   end
+
+  # Render and save graph to a file
+  def save_to_file(filename)
+    ext = File.extname(filename).gsub(/^\./, '')
+    pre_render(ext)
+    @image_drawer.save_to_file(filename)
+  end
+
+  # Render and return graph string
+  def to_format(ext)
+    pre_render(ext)
+    @image_drawer.to_format(ext)
+  end
+
+  # You don't have to run this
+  def pre_render(ext)
+    case ext
+      when 'svg', 'svgz' then
+        @options[:drawer_class] = :rasem
+        render
+
+      when 'png' then
+        if gem_available?('rmagick')
+          # rmagick is at the moment the best solution
+          @options[:drawer_class] = :rmagick
+        else
+          @options[:drawer_class] = :chunky_png
+        end
+        render
+
+      when 'jpeg', 'jpg', 'bmp', 'gif' then
+        if rmagick_installed?
+          @options[:drawer_class] = :rmagick
+          render
+        else
+          raise Gem::LoadError
+        end
+
+      else
+        raise ArgumentError
+
+    end
+  end
+
 end

data/lib/technical_graph/data_layer_processor_simple_smoother.rb

@@ -6,7 +6,7 @@ module DataLayerProcessorSimpleSmoother
     :rectangular => 'generate_vector_rectangular',
     :gauss => 'generate_vector_gauss'
   }
-  DEFAULT_SIMPLE_SMOOTHER_STRATEGY = :rectangular
+  DEFAULT_SIMPLE_SMOOTHER_STRATEGY = :gauss
 
   MIN_SIMPLE_SMOOTHER_LEVEL = 1
   MAX_SIMPLE_SMOOTHER_LEVEL = 200

data/lib/technical_graph/gem.rb

@@ -0,0 +1,12 @@
+def gem_available?(name)
+   Gem::Specification.find_by_name(name)
+rescue Gem::LoadError
+   false
+rescue
+   Gem.available?(name)
+end
+
+# Check if rmagick is installed
+def rmagick_installed?
+  gem_available?('rmagick')
+end

data/lib/technical_graph/graph_axis.rb

@@ -6,6 +6,9 @@ class GraphAxis
 
   attr_reader :technical_graph
 
+  # some issues with float precision and rounding
+  SAFE_ENL_COEFF = 1.1
+
   # Accessor for options Hash
   def options
     @technical_graph.options
@@ -125,10 +128,10 @@ class GraphAxis
 
   # Enlarge image to maintain proper axis density
   def axis_distance_image_enlarge
-    if options[:axis_density_enlarge_image]
+    if options[:axis_density_enlarge_image] or options[:x_axis_density_enlarge_image] or options[:y_axis_density_enlarge_image]
       t = Time.now
-      x_axis_distance_image_enlarge
-      y_axis_distance_image_enlarge
+      x_axis_distance_image_enlarge if options[:axis_density_enlarge_image] or options[:x_axis_density_enlarge_image]
+      y_axis_distance_image_enlarge if options[:axis_density_enlarge_image] or options[:y_axis_density_enlarge_image]
 
       logger.debug "axis enlarged"
       logger.debug " TIME COST #{Time.now - t}"
@@ -143,9 +146,9 @@ class GraphAxis
     return if a.size < 2
 
     ax = a[0]
-    ax = image.calc_bitmap_y(ax).round
+    ax = image.calc_bitmap_x(ax).round
     bx = a[1]
-    bx = image.calc_bitmap_y(bx).round
+    bx = image.calc_bitmap_x(bx).round
 
     axis_distance = (bx - ax).abs
 
@@ -153,7 +156,9 @@ class GraphAxis
     if axis_distance < options[:x_axis_min_distance]
       # enlarging image
       options[:old_width] = options[:width]
-      options[:width] *= (options[:x_axis_min_distance] / axis_distance).ceil
+      options[:width] = options[:width].to_f * (options[:x_axis_min_distance].to_f / axis_distance.to_f)
+      options[:width] *= SAFE_ENL_COEFF
+      options[:width] = options[:width].ceil
       logger.debug "axis enlarged - width modified to #{options[:width]}"
     end
   end
@@ -176,7 +181,9 @@ class GraphAxis
     if axis_distance < options[:y_axis_min_distance]
       # enlarging image
       options[:old_height] = options[:height]
-      options[:height] *= (options[:y_axis_min_distance] / axis_distance).ceil
+      options[:height] = options[:height].to_f * (options[:y_axis_min_distance].to_f / axis_distance.to_f)
+      options[:height] *= SAFE_ENL_COEFF
+      options[:height] = options[:height].ceil
       logger.debug "axis enlarged - height modified from #{options[:old_height]} to #{options[:height]}"
     end
   end