nanoc-graphviz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e0bd01739d6524dd4c8efccdf82035e2bd412a8
+  data.tar.gz: 3d14a2e26ac28df089647c643519b086f6ac8f3b
+SHA512:
+  metadata.gz: 0bc79161c9b8e775a35999958c6ba10231398bbbfe457201f77367811c6b4e5b86d61720b5228e9a7f2aa8ec1b7f6b18a61ed977ac8421b06492a76753bfb83a
+  data.tar.gz: a56ba59ee1300f1caf5c4306ca61078c7a20455a3545ec07d856d7bc29dfdcd1bae6a638f4f39bd26b1af0243f247a50a7589937e38be6bfeba1f97317af2aba

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 tetor
+
+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,50 @@
+[![Build Status](http://img.shields.io/travis/tetor/nanoc-graphviz.svg?style=flat)](https://travis-ci.org/tetor/nanoc-graphviz)
+
+# Nanoc::Graphviz
+
+Nanoc Graphviz filter plugin.
+
+This filter converts dot file to PNG.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nanoc-graphviz'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nanoc-graphviz
+
+## Usage
+
+This plugin adds `:graphviz` filter to nanoc.
+
+In Nanoc Rules file, please write compile and route settings as below.
+
+    compile '*' do
+      if item[:extension] == 'dot'
+        filter :graphviz
+      end
+    end
+
+    route '*' do
+      if item[:extension] == 'dot'
+        item.identifier.chop + '.png'
+      end
+    end
+
+If you forget route setting, the filter will generate PNG file but it extension will be same to source file. (perhaps '.dot')
+
+
+## Contributing
+
+1. Fork it ( https://github.com/tetor/nanoc-graphviz/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'yard'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs = %w(lib test)
+  t.test_files = FileList['test/nanoc-graphviz/test_*.rb']
+end
+
+YARD::Rake::YardocTask.new
+
+RuboCop::RakeTask.new
+
+task default: :test

data/lib/nanoc-graphviz.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'nanoc/graphviz'

data/lib/nanoc/graphviz.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'nanoc/graphviz/version'
+require 'nanoc/graphviz/filter'
+
+module Nanoc
+  # nanoc-graphviz Class
+  module Graphviz
+    # Your code goes here...
+  end
+end

data/lib/nanoc/graphviz/filter.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+# Graphviz filter
+module Nanoc
+  module Graphviz
+    # Graphviz Filter class
+    class Filter < Nanoc::Filter
+      # set filter name
+      identifier :graphviz
+      # type :type => :binary
+      type :binary
+
+      # convert Graphviz code to image
+      #
+      # @param [String] content  Graphviz code
+      # @return [Integer] command process status
+      # @raise [RuntimeError]
+      def run(content, _ = {})
+        fail 'Runtime environments is not ready' unless ready?
+        command = "dot -Tpng -o #{output_filename} < #{content}"
+        system(command)
+        $?
+      end
+
+      # check runtime envs
+      #
+      # @return [Boolean]
+      def ready?
+        graphviz_ready?
+      end
+
+      private
+
+      # Whether the Graphviz installed
+      #
+      # @return [Boolean]
+      def graphviz_ready?
+        if system('which dot >/dev/null 2>&1')
+          return true
+        end
+        false
+      end
+    end
+  end
+end

data/lib/nanoc/graphviz/version.rb

@@ -0,0 +1,6 @@
+module Nanoc
+  # nanoc-graphviz Class
+  module Graphviz
+    VERSION = '0.1.0'
+  end
+end

data/nanoc-graphviz.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nanoc/graphviz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nanoc-graphviz'
+  spec.version       = Nanoc::Graphviz::VERSION
+  spec.authors       = ['tetor']
+  spec.email         = ['akihatoetsu@gmail.com']
+  spec.summary       = 'nanoc graphviz filter plugin'
+  spec.description   = 'nanoc graphviz filter plugin'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency('nanoc', '>= 3.6.7', '< 4.0.0')
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-rg', '~> 5.1.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'redcarpet'
+end

data/test/minitest_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'nanoc'
+require 'nanoc/graphviz'
+
+require 'minitest/autorun'
+require 'minitest/rg'

data/test/nanoc-graphviz/test_filter.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+#
+# Graphviz filter test
+
+require 'minitest_helper'
+require 'tmpdir'
+
+module Nanoc
+  module Graphviz
+    # nanoc-graphviz Filter's test
+    class FilterTest < MiniTest::Test
+      def setup
+        @filter_class = ::Nanoc::Graphviz::Filter
+        @filter = @filter_class.new
+      end
+
+      def test_ready
+        if system('which dot >/dev/null 2>&1')
+          assert @filter.ready?, 'Running environment is not ready.'
+        else
+          assert !@filter.ready?, 'Running environment check is failed.'
+        end
+      end
+
+      def test_from_binary
+        assert @filter_class.from_binary?, 'from setting is not correct.'
+      end
+
+      def test_to_binary
+        assert @filter_class.to_binary?, 'to binary setting is not correct.'
+      end
+
+      # run method test
+      def test_run
+        if @filter.ready?
+          tmp_dir, filename = generate_test_item
+          assert_equal 0, @filter.run("#{tmp_dir}/#{filename}")
+          FileUtils.remove_entry tmp_dir
+        else
+          check_run_error
+        end
+      end
+
+      private
+
+      def check_run_error
+        @filter.run('foo')
+      rescue RuntimeError
+        assert true
+      else
+        assert false, 'Envs is not ready but no Error raisen'
+      end
+
+      def generate_test_item
+        dot_lang = 'graph graphname {a -- b -- c;b -- d;}'
+        in_f_name = 'graphviz_test.dot'
+
+        tmp_dir = Dir.mktmpdir
+        open("#{tmp_dir}/#{in_f_name}", 'w') do |f|
+          f.puts(dot_lang)
+        end
+        [tmp_dir, in_f_name]
+      end
+    end
+  end
+end

data/test/nanoc-graphviz/test_graphviz.rb

@@ -0,0 +1,16 @@
+require 'minitest_helper'
+
+module Nanoc
+  module Graphviz
+    # Test runner checker Class
+    class TestTest < MiniTest::Test
+      def test_tests_are_running
+        assert true
+      end
+
+      def test_that_it_has_a_version_number
+        refute_nil ::Nanoc::Graphviz::VERSION
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-graphviz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tetor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: nanoc graphviz filter plugin
+email:
+- akihatoetsu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nanoc-graphviz.rb
+- lib/nanoc/graphviz.rb
+- lib/nanoc/graphviz/filter.rb
+- lib/nanoc/graphviz/version.rb
+- nanoc-graphviz.gemspec
+- test/minitest_helper.rb
+- test/nanoc-graphviz/test_filter.rb
+- test/nanoc-graphviz/test_graphviz.rb
+homepage: ''
+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: nanoc graphviz filter plugin
+test_files:
+- test/minitest_helper.rb
+- test/nanoc-graphviz/test_filter.rb
+- test/nanoc-graphviz/test_graphviz.rb
+has_rdoc: