groff_parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 406e4d48011a846f365a37621e4ba1d91a9e5e35
-  data.tar.gz: 02d97ad12f839e36b35ff9d7c82197e935e218c8
+  metadata.gz: c4fc1b9649bdc2dcc2974e4a63fbe14cc9b792d4
+  data.tar.gz: 9ab8d0c06bcfcc6ad0411dcd7a336c90106ed2bd
 SHA512:
-  metadata.gz: 464732dbc63162c610ce01ec69e533ecd48bd4ae59893d5f26f9b3b3b3e4f3dcaee209573e8ac5fbc5c4daff547dfbd2828e0454a80b1ef47ffe79db426c42fd
-  data.tar.gz: c80a4373eceaf28529e77d99323dc4fe308bc65518a2d18eb5551fee48482aa8f37aab212166513d22812444b1548d2c185b1998492be081c3d31f2bfdbcb3e6
+  metadata.gz: 477c47e9a716095b00130ae0821b0811a066698c787173951cf3faf7c4d577de748e078fa959541ce1f5d77db4ca8ea376b5dbe6673c403b4f7b4025dcde7d5f
+  data.tar.gz: e444620aa38927793be68cac6b5f469a99af7f34a4814dacafe3cce20e78e6995086173be1668e1b64e7a0bb859c4faf19d8db2aba657e0800685c986b52dd23

data/README.md

@@ -3,7 +3,6 @@
 ### Status
 [![Gem Version](https://badge.fury.io/rb/groff_parser.png)](http://badge.fury.io/rb/groff_parser)
 [![Code Climate](https://codeclimate.com/github/roperzh/groff_parser.png)](https://codeclimate.com/github/roperzh/groff_parser)
-[![Dependencies](https://gemnasium.com/roperzh/groff_parser.png)](https://gemnasium.com/roperzh/groff_parser)
 
 Tiny library to parse groff files, with some handy metods to manage directories with a lot of files
 
@@ -23,7 +22,7 @@ Or install it yourself as:
 
 ## Basic Usage
 
-Coming soon, in the meantime you can read the [`docs`](http://rubydoc.info/gems/)
+Coming soon, in the meantime you can read the [`docs`](http://rubydoc.info/gems/groff_parser)
 
 
 ## Contributing

data/lib/groff_parser/document.rb

@@ -4,6 +4,8 @@ module GroffParser
 
   class Document
 
+    attr_accessor :path
+
     # Initializes the document class
     #
     # @since 0.1.0
@@ -42,7 +44,9 @@ module GroffParser
     #   doesn't exist yet
 
     def section(name)
-      raw_content[/SH \"#{name}\"(.*?)SH/im].gsub("SH", "")
+      raw_section = raw_content[/SH (?:\")?#{name}(?:\")?(.*?)SH/im]
+
+      return raw_section.gsub("SH", "").gsub("#{name}", "") if raw_section
     end
 
     # Raw content of the document, without being parsed, in pure

data/lib/groff_parser/engine.rb

@@ -44,15 +44,12 @@ module GroffParser
     #
     # @param zipped [Boolean] indicates if the file is zipped or not (gzip)
     #
-    # @param format [Symbol, String] indicates the output format, could be:
-    #   dvi, html, lbp, lj4, ps, ascii, cp1047, latin1, utf8, X75, X75, X100, X100
-    #
-    # @return [String] the content of the document, parsed in the proper format
+    # @return [GroffParser::Document] the document, parsed and ready to be manipulated
 
-    def parse(document_path, zipped, format: :utf8)
+    def parse(document_path, zipped: zipped)
       dpath = document_path.include?(path) ? document_path : "#{path}/#{document_path}"
 
-      Document.new(dpath, zipped: zipped).formatted_content(format)
+      Document.new(dpath, zipped: zipped)
     end
 
     # Parse all documents in a given directory, with a given format
@@ -65,14 +62,14 @@ module GroffParser
     #
     # @param zipped [Boolean] indicates if the file is zipped or not (gzip)
     #
-    # @return [Array] an array of all the parsed documents
+    # @return [Array<GroffParser::Document>] an array of all the parsed documents
 
     def parse_all(format: :utf8, zipped: false)
       documents   = []
       search_path = zipped ? "#{path}/*.gz" : "#{path}/*[0-9]"
 
       Dir.glob(search_path) do |document|
-        documents << parse(document, zipped, format: format)
+        documents << parse(document, zipped: zipped)
       end
 
       documents
@@ -85,9 +82,8 @@ module GroffParser
     # @example
     #  parser = GroffParser::Engine.new("/path/to/file")
     #  parser.apply { |document| document.parse }
-    #
 
-    def apply(*args)
+    def apply_to(*args)
       yield parse(args.join(" "))
     end
 
@@ -100,13 +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)
+    #
     # @return [nil]
 
-    def apply_all(*args)
-      search_path = args[0][:zipped] ? "#{path}/*.gz" : "#{path}/*"
+    def apply_to_all(zipped: false)
+      search_path = zipped ? "#{path}/*.gz" : "#{path}/*"
 
       Dir.glob(search_path) do |document|
-        yield parse(*args)
+        yield parse(document, zipped)
       end
     end
   end

data/lib/groff_parser/version.rb

@@ -1,3 +1,3 @@
 module GroffParser
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/document_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require File.expand_path(File.join("test/test_helper"))
 
 describe GroffParser::Document do
 
@@ -13,11 +13,11 @@ describe GroffParser::Document do
   describe "#section" do
     it "returns the contents of a section delimited by a given title" do
       zipped_document.section("NAME").must_equal(
-        " \"NAME\"\ngit \\- the stupid content tracker\n."
+        " \"\"\ngit \\- the stupid content tracker\n."
       )
 
       unzipped_document.section("NAME").must_equal(
-        " \"NAME\"\ngit \\- the stupid content tracker\n."
+        " \"\"\ngit \\- the stupid content tracker\n."
       )
     end
 
@@ -26,6 +26,10 @@ describe GroffParser::Document do
         unzipped_document.section("NAME")
       )
     end
+
+    it "returns nil if the provided section does not exists" do
+      zipped_document.section("UNEXISTENT_SECTION").must_equal(nil)
+    end
   end
 
   describe "#raw_content" do

data/test/engine_test.rb

@@ -5,17 +5,42 @@ describe GroffParser::Engine do
   let(:engine) { GroffParser::Engine.new(path: "test/fixtures") }
 
   describe "#parse" do
-    it "returns the contents of a document, formatted by the requested format" do
-      engine.parse("git.1.gz", true, format: :utf8).must_equal(
-        `cat test/fixtures/git.1 | groff -mandoc -Tutf8`
-      )
+    context "given a zipped document" do
+      it "returns a new GroffParser::Document instance" do
+        engine.parse("git.1.gz", zipped: true).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)
+            .raw_content
+        )
+      end
+    end
+
+    context "given an unzipped document" do
+      it "returns a new GroffParser::Document instance" do
+        engine.parse("git.1").class.must_equal(
+          GroffParser::Document
+        )
+      end
+
+      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)
+            .raw_content
+        )
+      end
     end
+
   end
 
   describe "#parse_all" do
     it "returns an array with all the documents contents present in the path" do
       engine.parse_all.must_equal(
-        [`cat test/fixtures/git.1 | groff -mandoc -Tutf8`]
+        [GroffParser::Document.new("test/fixtures/git.1", zipped: false)]
       )
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groff_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roberto Dip
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler