feedtxt 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a63195357fa98e1b02d6513762ae80282a69fda1
-  data.tar.gz: 6d95a5daca55ba51b167689c19cad486259ca9ca
+  metadata.gz: d789a406ff8c3b40a8796526c335f417b1d7bef7
+  data.tar.gz: bbb14f11154e100c1cf35df74d96de005d922bc8
 SHA512:
-  metadata.gz: e261cd043984b29ff7ed8532939a972f9e1738142477c5ab025017a13cc96f799a0f96f942d1d9a9a815c1332066ec6ef6f0b263028066f717415b785d085b62
-  data.tar.gz: c3bed556bd29fd1379ecd703422b1d7f427e6c57723f0b87f755331dfd1580a0d71cc44cefc4b11595c266c1b68db8513c44d36440ceb3eff42c74514bd736eb
+  metadata.gz: d6989519e169db7a4b8cbb24ce8fad4529934627ce196c262e777c42b11fcbfd4aaff20cc8d42131abe46b47a8ba572129462b59ba027358fe5394261f92909b
+  data.tar.gz: 94ee18c107eb40be036311b89219cf5662fc94aa66453e44b405d7ad1d2993fc0893daacd1eaccef05c775467bcfe65a1f75655cd891280c3b6c1e70c5bb8951

data/README.md

@@ -207,6 +207,36 @@ item_content
 Note: Feed.TXT supports alternative formats / styles for meta data blocks.
 For now YAML, JSON and INI style
 are built-in and shipping with the `feedtxt` gem.
+To use a format-specific parser use:
+
+- `Feedtxt::YAML.parse`
+- `Feedtxt::JSON.parse`
+- `Feedtxt::INI.parse`
+
+Note: `Feedtxt.parse` will handle all formats auto-magically,
+that is, it will check the text for the best matching (first)
+feed begin marker
+to find out what meta data format parser to use:
+
+| Format | `FEED_BEGIN` |  
+|--------|--------------|
+| YAML   | `\|>>>`      |
+| JSON   | `\|{`        |
+| INI    | `[>>>`       |
+
+
+Or use the built-in text pattern (regular expression)
+constants to find out:
+
+``` ruby
+Feedtxt::YAML::FEED_BEGIN
+# => "^[ ]*\\|>>>+[ ]*$"
+Feedtxt::JSON::FEED_BEGIN
+# => "^[ ]*\\|{+[ ]*$"
+Feedtxt::INI::FEED_BEGIN
+# => "^[ ]*\\[>>>+[ ]*$"
+```
+
 
 
 ### JSON Example
@@ -257,6 +287,26 @@ Hello, world!
 <<<]
 ```
 
+or
+
+```
+[>>>
+title:         My Example Feed
+home_page_url: https://example.org/
+feed_url:      https://example.org/feed.txt
+</>
+id:  2
+url: https://example.org/second-item
+---
+This is a second item.
+</>
+id:  1
+url: https://example.org/initial-post
+---
+Hello, world!
+<<<]
+```
+
 (Source: [`feeds/spec/example.ini.txt`](https://github.com/feedtxt/feedtxt/blob/master/test/feeds/spec/example.ini.txt))
 
 

data/lib/feedtxt.rb

@@ -33,6 +33,10 @@ module Feedtxt
   def self.parse( text, opts={} )
     Parser.parse( text,  )
   end
+
+  INI  = IniParser     ## note: add a shortcut; lets you use Feedtxt::INI.parse
+  YAML = YamlParser    ## note: add a shortcut; lets you use Feedtxt::YAML.parse
+  JSON = JsonParser    ## note: add a shortcut; lets you use Feedttxt::JSON.parse
 end
 
 

data/lib/feedtxt/parser.rb

@@ -23,25 +23,25 @@ class Parser
     ## auto-detect format
     ##   use "best" matching format (e.g. first match by pos(ition))
 
-    klass = YamlParser    ## default to yamlparser for now
-    pos   = 9999999     ## todo:use  MAX INTEGER or something!!
+    klass = YAML           ## default to yamlparser for now
+    pos   = 9_999_999     ## todo:use  MAX INTEGER or something!!
 
-    json = @text.index( /#{JsonParser::FEED_BEGIN}/ )
+    json = @text.index( /#{JSON::FEED_BEGIN}/ )
     if json    # found e.g. not nil? incl. 0
       pos   = json
-      klass = JsonParser
+      klass = JSON
     end
 
-    ini = @text.index( /#{IniParser::FEED_BEGIN}/ )
+    ini = @text.index( /#{INI::FEED_BEGIN}/ )
     if ini && ini < pos  # found e.g. not nil? and match before last?
       pos   = ini
-      klass = IniParser
+      klass = INI
     end
 
-    yaml = @text.index( /#{YamlParser::FEED_BEGIN}/ )
+    yaml = @text.index( /#{YAML::FEED_BEGIN}/ )
     if yaml && yaml < pos  # found e.g. not nil? and match before last?
       pos   = yaml
-      klass = YamlParser
+      klass = YAML
     end
 
     feed = klass.parse( @text )

data/lib/feedtxt/parser/ini.rb

@@ -75,7 +75,7 @@ class IniParser
     ## 1st block is feed meta data
     block1st = blocks.shift       ## get/remove 1st block from blocks
     block1st = block1st.strip     ## strip leading and trailing whitespace
-    feed_metadata = INI.load( block1st )
+    feed_metadata = ::INI.load( block1st )
 
     feed_items = []
     blocks.each do |block|
@@ -87,7 +87,7 @@ class IniParser
 
       item_metadata = s2.scan_until( /(?=#{FEED_META})/ )
       item_metadata = item_metadata.strip    # remove leading and trailing whitespace
-      item_metadata = INI.load( item_metadata )   ## convert to hash with inifile parser
+      item_metadata = ::INI.load( item_metadata )   ## convert to hash with inifile parser
 
       feed_meta = s2.scan( /#{FEED_META}/ )
 
@@ -103,4 +103,5 @@ class IniParser
 
 end  # class IniParser
 
+
 end # module Feedtxt

data/lib/feedtxt/parser/json.rb

@@ -79,7 +79,7 @@ class JsonParser
     ## 1st block is feed meta data
     block1st = blocks.shift       ## get/remove 1st block from blocks
     block1st = block1st.strip    # remove leading and trailing whitespaces
-    feed_metadata = JSON.parse( "{ #{block1st} }" )
+    feed_metadata = ::JSON.parse( "{ #{block1st} }" )
 
     feed_items = []
     blocks.each do |block|
@@ -91,7 +91,7 @@ class JsonParser
 
       item_metadata = s2.scan_until( /(?=#{FEED_META})/ )
       item_metadata = item_metadata.strip    # remove leading and trailing whitespace
-      item_metadata = JSON.parse( "{ #{item_metadata} }" )   ## convert to hash with yaml
+      item_metadata = ::JSON.parse( "{ #{item_metadata} }" )   ## convert to hash with yaml
 
       feed_meta = s2.scan( /#{FEED_META}/ )
 

data/lib/feedtxt/parser/yaml.rb

@@ -75,7 +75,7 @@ class YamlParser
     ## 1st block is feed meta data
     block1st = blocks.shift       ## get/remove 1st block from blocks
     block1st = block1st.strip     ## strip leading and trailing whitespace
-    feed_metadata = YAML.load( block1st )
+    feed_metadata = ::YAML.load( block1st )
 
     feed_items = []
     blocks.each do |block|
@@ -87,7 +87,7 @@ class YamlParser
 
       item_metadata = s2.scan_until( /(?=#{FEED_META})/ )
       item_metadata = item_metadata.strip    # remove leading and trailing whitespace
-      item_metadata = YAML.load( item_metadata )   ## convert to hash with yaml
+      item_metadata = ::YAML.load( item_metadata )   ## convert to hash with yaml
 
       feed_meta = s2.scan( /#{FEED_META}/ )
 

data/lib/feedtxt/version.rb

@@ -4,7 +4,7 @@ module Feedtxt
 
   MAJOR = 1
   MINOR = 0
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/test_ini.rb

@@ -27,7 +27,7 @@ class TestIni < MiniTest::Test
        "Hello, world!"
     ]]]
 
-    assert_equal exp, Feedtxt::IniParser.parse( text )
+    assert_equal exp, Feedtxt::INI.parse( text )
     assert_equal exp, Feedtxt.parse( text )     ## try shortcut alias too
   end
 
@@ -54,7 +54,7 @@ class TestIni < MiniTest::Test
       "duration_in_seconds"=>"6629"}},
    "Chris has worked at [Adobe][1] and as a founder of Rogue Sheep, which won an Apple Design Award for Postage.\nChris's new company is Aged & Distilled with Guy English - which shipped [Napkin](2),\na Mac app for visual collaboration. Chris is also the co-host of The Record.\nHe lives on [Bainbridge Island][3], a quick ferry ride from Seattle.\n\n[1]: http://adobe.com/\n[2]: http://aged-and-distilled.com/napkin/\n[3]: http://www.ci.bainbridge-isl.wa.us/"]]]
 
-    assert_equal exp, Feedtxt::IniParser.parse( text )
+    assert_equal exp, Feedtxt::INI.parse( text )
     assert_equal exp, Feedtxt.parse( text )   ## try shortcut alias too
   end
 

data/test/test_json.rb

@@ -27,7 +27,7 @@ class TestJson < MiniTest::Test
        "Hello, world!"
     ]]]
 
-    assert_equal exp, Feedtxt::JsonParser.parse( text )
+    assert_equal exp, Feedtxt::JSON.parse( text )
     assert_equal exp, Feedtxt.parse( text )     ## try shortcut alias too
   end
 
@@ -55,7 +55,7 @@ class TestJson < MiniTest::Test
        "duration_in_seconds"=>6629}]},
    "Chris has worked at [Adobe][1] and as a founder of Rogue Sheep, which won an Apple Design Award for Postage.\nChris's new company is Aged & Distilled with Guy English - which shipped [Napkin](2),\na Mac app for visual collaboration. Chris is also the co-host of The Record.\nHe lives on [Bainbridge Island][3], a quick ferry ride from Seattle.\n\n[1]: http://adobe.com/\n[2]: http://aged-and-distilled.com/napkin/\n[3]: http://www.ci.bainbridge-isl.wa.us/"]]]
 
-    assert_equal exp, Feedtxt::JsonParser.parse( text )
+    assert_equal exp, Feedtxt::JSON.parse( text )
     assert_equal exp, Feedtxt.parse( text )   ## try shortcut alias too
   end
 

data/test/test_yaml.rb

@@ -27,7 +27,7 @@ class TestYaml < MiniTest::Test
        "Hello, world!"
     ]]]
 
-    assert_equal exp, Feedtxt::YamlParser.parse( text )
+    assert_equal exp, Feedtxt::YAML.parse( text )
     assert_equal exp, Feedtxt.parse( text )     ## try shortcut alias too
   end
 
@@ -55,7 +55,7 @@ class TestYaml < MiniTest::Test
        "duration_in_seconds"=>6629}]},
    "Chris has worked at [Adobe][1] and as a founder of Rogue Sheep, which won an Apple Design Award for Postage.\nChris's new company is Aged & Distilled with Guy English - which shipped [Napkin](2),\na Mac app for visual collaboration. Chris is also the co-host of The Record.\nHe lives on [Bainbridge Island][3], a quick ferry ride from Seattle.\n\n[1]: http://adobe.com/\n[2]: http://aged-and-distilled.com/napkin/\n[3]: http://www.ci.bainbridge-isl.wa.us/"]]]
 
-    assert_equal exp, Feedtxt::YamlParser.parse( text )
+    assert_equal exp, Feedtxt::YAML.parse( text )
     assert_equal exp, Feedtxt.parse( text )   ## try shortcut alias too
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feedtxt
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc