guard-docbook-status 0.1.0

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+gem "guard"
+gem "docbook_status"
+
+group :development do
+  gem "bones"
+  gem "guard"
+  gem "rspec"
+  gem 'rb-fsevent'
+  gem 'growl_notify'
+  gem 'guard-rspec'  
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bones (3.7.1)
+      little-plugger (>= 1.1.2)
+      loquacious (>= 1.8.1)
+      rake (>= 0.8.7)
+    diff-lcs (1.1.3)
+    directory_watcher (1.4.1)
+    docbook_status (0.4.0)
+      directory_watcher (>= 1.4.1)
+      json (>= 1.6.1)
+      libxml-ruby (>= 2.2.2)
+      term-ansicolor (>= 1.0.6)
+    growl_notify (0.0.3)
+      rb-appscript
+    guard (0.8.4)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.0)
+      guard (>= 0.8.4)
+    json (1.6.1)
+    libxml-ruby (2.2.2)
+    little-plugger (1.1.2)
+    loquacious (1.9.0)
+    rake (0.9.2)
+    rb-appscript (0.6.1)
+    rb-fsevent (0.4.3.1)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    term-ansicolor (1.0.7)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bones
+  docbook_status
+  growl_notify
+  guard
+  guard-rspec
+  rb-fsevent
+  rspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :version => 2, :cli => "--color --format nested" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 / 2011-10-15
+
+* first release
+

data/README.md

@@ -0,0 +1,71 @@
+guard-docbook-status
+===========
+
+The docbook-status guard will watch your DocBook documents and check
+their status when they change. It is meant to work with the
+'docbook_status'  utility, see https://github.com/rvolz/docbook_status
+
+Usage
+--------
+
+See the [Guard documentation](https://github.com/guard/guard#readme) for general instructions.
+
+To start with this add-on, create your Guardfile with:
+
+    guard init docbook-status
+
+Then change the resulting Guardfile, if necessary. The standard Guardfile looks like this:
+
+    guard 'docbook-status', :cli => '--remarks myproject.xml' do
+       watch(/.+\.xml$/i)
+    end
+
+To adapt the Guardfile to your requirements:
+
+* change the _cli_ option. It can contain all options that you would normally use to start docbook_status.
+* change the _watch_ statement. The regular expression currently looks for changes in all XML files. A change there would trigger the processing by docbook_status.
+
+Install
+-------
+
+Since you are reading this, it is assumed that you have docbook_status already installed. Since this is a Guard add-on, you'll need also [Guard](https://github.com/guard/guard) to be installed. 
+
+Then install this add-on with
+
+    gem install guard-docbook-status
+
+or add it to your Gemfile
+
+    gem 'guard-docbook-status'
+
+
+Author
+------
+
+Original author: Rainer Volz
+
+License
+-------
+
+(The MIT License) 
+
+Copyright (c) 2011 Rainer Volz
+
+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/Rakefile

@@ -0,0 +1,20 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+task :default => 'spec'
+task 'gem:release' => 'spec'
+
+Bones {
+  name     'guard-docbook-status'
+  authors  'Rainer Volz'
+  email    'dev@textmulch.de'
+  url      'https://github.com/rvolz/guard-docbook-status/'
+  ignore_file  '.gitignore'
+  depend_on     'docbook_status'
+  depend_on     'guard'
+}
+

data/lib/guard/docbook-status.rb

@@ -0,0 +1,35 @@
+# *-* encoding: utf-8 -*-
+require 'guard'
+require 'guard/guard'
+require 'guard/watcher'
+
+module Guard
+  class DocbookStatus < Guard
+    
+    def initialize(watchers=[], options={})
+      super
+      @options = {
+        :trigger_on_start => true
+      }.update(options)
+    end
+
+    def start
+      ::Guard::UI.info("Guard::DocbookStatus has started watching your files")
+      run_all if @options[:trigger_on_start]
+    end
+
+    def run_all
+      run_on_change([])
+    end
+
+    def run_on_change(paths)
+      ::Guard::UI.info("Guard::DocbookStatus detected a change")
+      output = system("docbook_status #{@options[:cli]}")
+      command_failure = ($?.to_i != 0)
+      if command_failure
+        ::Guard::UI.error("docbook_status indicated an error")
+      end
+    end
+  end
+end
+    

data/lib/guard/docbook-status/templates/Guardfile

@@ -0,0 +1,3 @@
+guard 'docbook-status', :cli => '--remarks myproject.xml' do
+  watch(/.+\.xml$/i)
+end

data/lib/guard/docbook-status/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  class DocbookStatus
+    VERSION = '0.1.0'
+  end
+end

data/spec/fixtures/bookxi.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<book xmlns="http://docbook.org/ns/docbook"
+	xmlns:xi="http://www.w3.org/2001/XInclude"
+	version="5.0">
+  <title>B1</title>
+  <chapter>
+    <title>C1</title>
+    <para>
+       Dies ist ein Test .. Dies ist ein  Test.
+       In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+    </para>
+  </chapter>
+  <xi:include href="chapter2xi.xml"/>
+  <xi:include href="chapter3xi.xml"/>
+  <xi:include href="c4/chapter4xi.xml"/>
+</book>

data/spec/fixtures/c4/chapter4xi.xml

@@ -0,0 +1,8 @@
+  <chapter xmlns="http://docbook.org/ns/docbook" version="5.0">
+    <title>C4</title>
+    <para>
+       Dies ist ein Test .. Dies ist ein  Test.
+       In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+       <remark>FIXME 3 Ausbauen.</remark>
+    </para>
+  </chapter>

data/spec/fixtures/chapter2xi.xml

@@ -0,0 +1,11 @@
+<chapter xmlns="http://docbook.org/ns/docbook"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+           version="5.0">
+  <title>C2</title>
+  <para>
+    Dies ist ein Test .. Dies ist ein  Test.
+    In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+    <remark>FIXME Ausbauen.</remark>
+  </para>
+  <xi:include href="section1xi.xml"/>
+</chapter>

data/spec/fixtures/chapter3xi.xml

@@ -0,0 +1,8 @@
+  <chapter xmlns="http://docbook.org/ns/docbook" version="5.0">
+    <title>C3</title>
+    <para>
+       Dies ist ein Test .. Dies ist ein  Test.
+       In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+       <remark>FIXME 3 Ausbauen.</remark>
+    </para>
+  </chapter>

data/spec/fixtures/section1xi.xml

@@ -0,0 +1,9 @@
+<section xmlns="http://docbook.org/ns/docbook"
+         version="5.0">
+  <title>S1</title>
+  <para>
+    Dies ist ein Test .. Dies ist ein  Test.
+    In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+    <remark>TODO S1 Ausbauen.</remark>
+  </para>
+</section>

data/spec/guard/docbook-status_spec.rb

@@ -0,0 +1,55 @@
+
+#require File.join(File.dirname(__FILE__), %w[spec_helper])
+require 'spec_helper'
+require 'guard'
+require 'guard/ui'
+require 'guard/watcher'
+require 'fileutils'
+
+module Guard
+  describe DocbookStatus do
+    before(:each) do
+      @gdbs = DocbookStatus.new
+    end
+
+    describe "start" do
+      it "should trigger dbs on start" do
+        ::Guard::UI.should_receive(:info).with("Guard::DocbookStatus has started watching your files")
+        ::Guard::UI.should_receive(:info).with("Guard::DocbookStatus detected a change")
+        ::Guard::UI.should_receive(:error).with("docbook_status indicated an error")
+        @gdbs.start
+      end
+
+      it "should process a file on start" do
+        FileUtils.rm_rf 'spec/work'
+        FileUtils.cp_r 'spec/fixtures/', 'spec/work/'
+        ::Guard::UI.should_receive(:info).with("Guard::DocbookStatus has started watching your files")
+        ::Guard::UI.should_receive(:info).with("Guard::DocbookStatus detected a change")
+        ::Guard::UI.should_not_receive(:error)
+        @gdbs = DocbookStatus.new(["*.xml"],{:cli => 'spec/work/bookxi.xml'})
+        @gdbs.start
+      end
+    end
+
+    describe "run_on_change" do
+      it "should process a file in the working dir" do
+        w = Watcher.new("spec/fixtures/*.xml")
+        ::Guard::UI.should_receive(:info).with("Guard::DocbookStatus has started watching your files")
+        @gdbs = DocbookStatus.new([w],{:cli => 'bookxi.xml'})
+        @gdbs.should_receive(:run_on_change).twice
+        @gdbs.start
+        @gdbs.run_on_change(["chapter2xi.xml"])
+        
+      end
+      it "should process a file in a subdir" do
+        w = Watcher.new("spec/fixtures/**/*.xml")
+        ::Guard::UI.should_receive(:info).with("Guard::DocbookStatus has started watching your files")
+        @gdbs = DocbookStatus.new([w],{:cli => 'bookxi.xml'})
+        @gdbs.should_receive(:run_on_change).twice
+        @gdbs.start
+        @gdbs.run_on_change(["chapter4xi.xml"])
+      end      
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib guard docbook-status]))
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+

data/spec/work/bookxi.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<book xmlns="http://docbook.org/ns/docbook"
+	xmlns:xi="http://www.w3.org/2001/XInclude"
+	version="5.0">
+  <title>B1</title>
+  <chapter>
+    <title>C1</title>
+    <para>
+       Dies ist ein Test .. Dies ist ein  Test.
+       In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+    </para>
+  </chapter>
+  <xi:include href="chapter2xi.xml"/>
+  <xi:include href="chapter3xi.xml"/>
+  <xi:include href="c4/chapter4xi.xml"/>
+</book>

data/spec/work/c4/chapter4xi.xml

@@ -0,0 +1,8 @@
+  <chapter xmlns="http://docbook.org/ns/docbook" version="5.0">
+    <title>C4</title>
+    <para>
+       Dies ist ein Test .. Dies ist ein  Test.
+       In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+       <remark>FIXME 3 Ausbauen.</remark>
+    </para>
+  </chapter>

data/spec/work/chapter2xi.xml

@@ -0,0 +1,11 @@
+<chapter xmlns="http://docbook.org/ns/docbook"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+           version="5.0">
+  <title>C2</title>
+  <para>
+    Dies ist ein Test .. Dies ist ein  Test.
+    In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+    <remark>FIXME Ausbauen.</remark>
+  </para>
+  <xi:include href="section1xi.xml"/>
+</chapter>

data/spec/work/chapter3xi.xml

@@ -0,0 +1,8 @@
+  <chapter xmlns="http://docbook.org/ns/docbook" version="5.0">
+    <title>C3</title>
+    <para>
+       Dies ist ein Test .. Dies ist ein  Test.
+       In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+       <remark>FIXME 3 Ausbauen.</remark>
+    </para>
+  </chapter>

data/spec/work/section1xi.xml

@@ -0,0 +1,9 @@
+<section xmlns="http://docbook.org/ns/docbook"
+         version="5.0">
+  <title>S1</title>
+  <para>
+    Dies ist ein Test .. Dies ist ein  Test.
+    In den Jahren 1900-1901 geschahen viele Überfälle von O`Reillys.
+    <remark>TODO S1 Ausbauen.</remark>
+  </para>
+</section>

data/version.txt

@@ -0,0 +1 @@
+0.1.0

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: guard-docbook-status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Rainer Volz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docbook_status
+  requirement: &2166150860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2166150860
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2166149960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2166149960
+- !ruby/object:Gem::Dependency
+  name: bones
+  requirement: &2166149240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+  type: :development
+  prerelease: false
+  version_requirements: *2166149240
+description: ! 'The docbook-status guard will watch your DocBook documents and check
+
+  their status when they change. It is meant to work with the
+
+  ''docbook_status''  utility, see https://github.com/rvolz/docbook_status'
+email: dev@textmulch.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- lib/guard/docbook-status/templates/Guardfile
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- History.txt
+- README.md
+- Rakefile
+- lib/guard/docbook-status.rb
+- lib/guard/docbook-status/templates/Guardfile
+- lib/guard/docbook-status/version.rb
+- spec/fixtures/bookxi.xml
+- spec/fixtures/c4/chapter4xi.xml
+- spec/fixtures/chapter2xi.xml
+- spec/fixtures/chapter3xi.xml
+- spec/fixtures/section1xi.xml
+- spec/guard/docbook-status_spec.rb
+- spec/spec_helper.rb
+- spec/work/bookxi.xml
+- spec/work/c4/chapter4xi.xml
+- spec/work/chapter2xi.xml
+- spec/work/chapter3xi.xml
+- spec/work/section1xi.xml
+- version.txt
+homepage: https://github.com/rvolz/guard-docbook-status/
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: guard-docbook-status
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: The docbook-status guard will watch your DocBook documents and check their
+  status when they change.
+test_files: []