groff_parser 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 429a3819c295efa69034015dc48dccc2403ce1ea
-  data.tar.gz: 6ad5111a4abcdb2ff5fd12870e84289ea08673dd
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzlhMjU3N2MzNTMyNzMyMDZhMTIwMmFkN2RlNTY1NGNjYjRhNTdjOQ==
+  data.tar.gz: !binary |-
+    YTFkYzdkYzgyYmQ0Y2RkNjYyZjg0YTliNmRkNmJiYTA1YzYwNDhlYw==
 SHA512:
-  metadata.gz: 62c4fb592f27be4d2fdad3195f78160e191152fcef6396a69dae9a0921a5403c4469e973a5c43e5d20a9e861fcb5baa2e5e04f79fdda9d960eb98785d7b04fe6
-  data.tar.gz: 8d1a5e7db5f2f97bfbe35946c63eb31de024e1bceb8b215f24dd6fed94b51f6d17ccdaf0f04d0c2efd18aaa2a9b642a026c0a26cd54f2f24bf92642e0b8779a0
+  metadata.gz: !binary |-
+    M2MxZTY4YjE5ZDY4NWZkMGM1YmI0MTJmOTJjYWY3YWQ5MThmZGEzNzE1ODNm
+    YjhlZDY0MTgxZjU0ZjE1Y2Q0NTBhYzM3MDhkMTIzMDRjNDkyMjM3ZGRlNDdh
+    NjM5MjRiMDI2MzFkN2RjMGZiNDQ3OWE5MzkwZDEzODViZTZiNDE=
+  data.tar.gz: !binary |-
+    YjdhMTBjMzY1MjU2MmI0ZmJjN2I3MmZkZjM3YzhlZWIyODUyMTU3ZWU0Yzc2
+    YjQ4Nzk5NDNkMmVlZTAxM2JjNGIwNjNmYTVlNzM5ODYxYTU0YzI4ZDg1OGMy
+    YjAxMWQxMzA0ZTVkYTk3NmQ1MzdhZGQyYTAyNGEyZjlhMDhmNmY=

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-1.7.9
+
+before_install:
+  - sudo apt-get install groff

data/README.md

@@ -2,28 +2,28 @@
 
 ### Status
 [![Gem Version](https://badge.fury.io/rb/groff_parser.png)](http://badge.fury.io/rb/groff_parser)
+[![Build Status](https://secure.travis-ci.org/roperzh/groff_parser.png?branch=master)](http://travis-ci.org/roperzh/groff_parser?branch=master)
 [![Code Climate](https://codeclimate.com/github/roperzh/groff_parser.png)](https://codeclimate.com/github/roperzh/groff_parser)
 
 Tiny library to parse groff files, with some handy metods to manage directories with a lot of files
 
 ## Installation
 
-Add this line to your application's Gemfile:
+This gem relies on the [`groff`](http://savannah.gnu.org/projects/groff) GNU package, so in order to work you will need to install it.
 
-    gem 'groff_parser'
+```bash
+apt-get install groff
+```
 
-And then execute:
+If you already have the `groff` package, just install the gem as usual:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install groff_parser
+```bash
+  $ gem install groff_parser
+```
 
 ## Basic Usage
 
-Coming soon, in the meantime you can read the [`docs`](http://rubydoc.info/gems/groff_parser)
-
+For a detailed information about how the gem works internally, you can take a look at the [`docs`](http://rubydoc.info/gems/groff_parser)
 
 ## Contributing
 

data/lib/groff_parser/document.rb

@@ -11,16 +11,16 @@ module GroffParser
     # @since 0.1.0
     #
     # @example
-    #   zipped_document = GroffParser::Document.new("path/to/file.gz", zipped: true)
-    #   unzipped_document = GroffParser::Document.new("path/to/file.1",  zipped: false)
+    #   zipped_document = GroffParser::Document.new("path/to/file.gz", :zipped)
+    #   unzipped_document = GroffParser::Document.new("path/to/file.1")
     #
     # @param path [String] the path where the document is located
     #
-    # @param zipped [Boolean] indicates if the document is zipped or not
+    # @param zipped [Symbol, Boolean, String] indicates if the document is zipped or not
     #
     # @return [GroffParser::Document] a new instance of a Document class
 
-    def initialize(path, zipped: false)
+    def initialize(path, zipped = nil)
       @path   = path
       @zipped = zipped
     end
@@ -49,6 +49,24 @@ module GroffParser
       return raw_section.gsub("SH", "").gsub("#{name}", "") if raw_section
     end
 
+    # Executes the groff command, with a given set of flags, and returns the
+    # output
+    #
+    # @since 0.4.0
+    #
+    # @example
+    #   document.groff(m: :mandoc)
+    #   # will execute: `groff -m mandoc
+    #
+    # @param flags [Hash] hash containing flags in key-value format
+    #
+    # @return [String] the result of the command
+
+
+    def groff(flags = {})
+      `#{get} #{@path} | groff #{formatted_flags(flags)}`
+    end
+
     # Raw content of the document, without being parsed, in pure
     # groff format
     #
@@ -57,10 +75,12 @@ module GroffParser
     # @example
     #   document.raw_content
     #
+    # @param flags [Hash] hash containing flags in key-value format
+    #
     # @return [String] the document content in groff format
 
-    def raw_content
-      @raw_content ||= `#{get} #{@path}`
+    def raw_content(flags = {})
+      @raw_content ||= `#{get} #{@path} #{formatted_flags(flags)}`
     end
 
     # Content of the document in a especific format
@@ -73,10 +93,12 @@ module GroffParser
     # @param format [Symbol, String] indicates the output format, could be:
     #   dvi, html, lbp, lj4, ps, ascii, cp1047, latin1, utf8, X75, X75, X100, X100
     #
+    # @param flags [Hash] hash containing flags in key-value format
+    #
     # @return [String] the document content formated in the requested format
 
-    def formatted_content(format)
-      `#{get} #{@path} | groff -mandoc -T#{format}`
+    def formatted_content(format, flags = {})
+      `#{get} #{@path} | groff -mandoc -T#{format} #{formatted_flags(flags)}`
     end
 
     private
@@ -98,5 +120,23 @@ module GroffParser
     def get
       @zipped ? "zcat" : "cat"
     end
+
+    # Helper to reduce a hash containing flags to a single line string
+    # according to the usual GNU convention
+    #
+    # @since 0.4.0
+    #
+    # @example
+    #   formatted_flags(m: :mandoc) # => "-mmandoc"
+    #
+    # @params flags [Hash] flags to be reduced
+    #
+    # @return [String] string with the parsed flags following the usual GNU convention
+
+    def formatted_flags(flags)
+      flags.reduce("") {
+        |result, flag| result.concat(" -#{flag[0]}#{flag[1]}")
+      }
+    end
   end
 end

data/lib/groff_parser/engine.rb

@@ -23,8 +23,8 @@ module GroffParser
     #
     # @return [GroffParser::Engine] a new Engine instance
 
-    def initialize(path: Dir.pwd)
-      @path = path
+    def initialize(path)
+      @path = path || Dir.pwd
     end
 
     # Parse a document located on a given path, if the document is contained
@@ -42,14 +42,14 @@ module GroffParser
     #
     # @param document_path [String] path for a document to parse
     #
-    # @param zipped [Boolean] indicates if the file is zipped or not (gzip)
+    # @param zipped [Symbol, Boolean, String] indicates if the file is zipped or not (gzip)
     #
     # @return [GroffParser::Document] the document, parsed and ready to be manipulated
 
-    def parse(document_path, zipped: zipped)
+    def parse(document_path, zipped = nil)
       dpath = document_path.include?(path) ? document_path : "#{path}/#{document_path}"
 
-      Document.new(dpath, zipped: zipped)
+      Document.new(dpath, zipped)
     end
 
     # Parse all documents in a given directory, with a given format
@@ -60,16 +60,16 @@ module GroffParser
     #   dvi, html, lbp, lj4, ps, ascii, cp1047, latin1, utf8, X75, X75, X100, X100
     #   (default = utf8)
     #
-    # @param zipped [Boolean] indicates if the file is zipped or not (gzip)
+    # @param zipped [Symbol, Boolean, String] indicates if the file is zipped or not (gzip)
     #
     # @return [Array<GroffParser::Document>] an array of all the parsed documents
 
-    def parse_all(format: :utf8, zipped: false)
+    def parse_all(zipped = nil)
       documents   = []
       search_path = zipped ? "#{path}/*.gz" : "#{path}/*[0-9]"
 
       Dir.glob(search_path) do |document|
-        documents << parse(document, zipped: zipped)
+        documents << parse(document, zipped)
       end
 
       documents
@@ -96,15 +96,15 @@ module GroffParser
     #   parser = GroffParser::Engine.new("/folder/with/some/files")
     #   parser.apply_all { |document|  document.parse }
     #
-    # @param zipped [Boolean] indicates if the file is zipped or not (gzip)
+    # @param zipped [Symbol, Boolean, String] indicates if the file is zipped or not (gzip)
     #
     # @return [nil]
 
-    def apply_to_all(zipped: false)
+    def apply_to_all(zipped = nil)
       search_path = zipped ? "#{path}/*.gz" : "#{path}/*"
 
       Dir.glob(search_path) do |document|
-        yield parse(document, zipped: zipped)
+        yield parse(document, zipped)
       end
     end
   end

data/lib/groff_parser/version.rb

@@ -1,3 +1,3 @@
 module GroffParser
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/test/document_test.rb

@@ -3,13 +3,15 @@ require File.expand_path(File.join("test/test_helper"))
 describe GroffParser::Document do
 
   let(:zipped_document)   {
-    GroffParser::Document.new("test/fixtures/git.1.gz", zipped: true)
+    GroffParser::Document.new("test/fixtures/git.1.gz", :zipped)
   }
 
   let(:unzipped_document) {
-    GroffParser::Document.new("test/fixtures/git.1", zipped: false)
+    GroffParser::Document.new("test/fixtures/git.1")
   }
 
+  let(:timestamp) { Regexp.new(/\<\!\-\- CreationDate\: (.*?) \-\-\>/) }
+
   describe "#section" do
     it "returns the contents of a section delimited by a given title" do
       zipped_document.section("NAME").must_equal(
@@ -49,7 +51,6 @@ describe GroffParser::Document do
   end
 
   describe "#formatted_content" do
-    let(:timestamp) { Regexp.new(/\<\!\-\- CreationDate\: (.*?) \-\-\>/) }
 
     it "returns the content in the requested format" do
       # Due to a small delay parsing data, we need to supress the timestamps
@@ -74,4 +75,30 @@ describe GroffParser::Document do
       )
     end
   end
+
+  describe "#groff" do
+    context "given a set of flags" do
+      it "executes the groff command with the flags provided" do
+        zipped_document.groff(:T => :utf8, :m => :mandoc).must_equal(
+          `zcat test/fixtures/git.1.gz | groff -Tutf8 -mmandoc`
+        )
+
+        zipped_document.groff(:T => :utf8, :m => :mandoc).must_equal(
+          `cat test/fixtures/git.1 | groff -Tutf8 -mmandoc`
+        )
+      end
+    end
+
+    context "without flags" do
+      it "executes groff command without any aditional options" do
+        zipped_document.groff.gsub(timestamp, "").must_equal(
+          `zcat test/fixtures/git.1.gz | groff`.gsub(timestamp, "")
+        )
+
+        zipped_document.groff.gsub(timestamp, "").must_equal(
+          `cat test/fixtures/git.1 | groff`.gsub(timestamp, "")
+        )
+      end
+    end
+  end
 end

data/test/engine_test.rb

@@ -2,19 +2,19 @@ require File.expand_path(File.join("test/test_helper"))
 
 describe GroffParser::Engine do
 
-  let(:engine) { GroffParser::Engine.new(path: "test/fixtures") }
+  let(:engine) { GroffParser::Engine.new("test/fixtures") }
 
   describe "#parse" do
     context "given a zipped document" do
       it "returns a new GroffParser::Document instance" do
-        engine.parse("git.1.gz", zipped: true).class.must_equal(
+        engine.parse("git.1.gz", :zipped).class.must_equal(
           GroffParser::Document
         )
       end
 
       it "allows to retrieve information of the parsed file" do
-        engine.parse("git.1.gz", zipped: true).raw_content.must_equal(
-          GroffParser::Document.new("test/fixtures/git.1.gz", zipped: true)
+        engine.parse("git.1.gz", :zipped).raw_content.must_equal(
+          GroffParser::Document.new("test/fixtures/git.1.gz", :zipped)
             .raw_content
         )
       end
@@ -29,7 +29,7 @@ describe GroffParser::Engine do
 
       it "allows to retrieve information of the parsed file" do
         engine.parse("git.1").raw_content.must_equal(
-          GroffParser::Document.new("test/fixtures/git.1.gz", zipped: true)
+          GroffParser::Document.new("test/fixtures/git.1.gz", :zipped)
             .raw_content
         )
       end
@@ -39,9 +39,11 @@ describe GroffParser::Engine do
 
   describe "#parse_all" do
     it "returns an array with all the documents contents present in the path" do
-      engine.parse_all.must_equal(
-        [GroffParser::Document.new("test/fixtures/git.1", zipped: false)]
-      )
+      documents = engine.parse_all
+
+      documents.length.must_equal(1)
+      documents.first.class.must_equal(GroffParser::Document)
+      documents.first.path.must_equal("test/fixtures/git.1")
     end
   end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: groff_parser
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Roberto Dip
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   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: 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: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
   name: inch
   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: Tiny library to parse groff files, with some handy metods to manage directories
@@ -74,7 +74,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -99,12 +100,12 @@ 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: []