mtif 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 44c470cee7b56a046a34966a7b58929cdb0e621b
-  data.tar.gz: a945fa44a90c6b21eca02c4e6004a42ddb85f81d
+SHA256:
+  metadata.gz: ecef4cc75fdd2298659ea13b4b95bd4bffe17ac255dc48d95c7285fce1b09d3e
+  data.tar.gz: 3aca00918efdea29df349cf13e4391d260f8c4c4d6821f8d880b18d17bfc7b12
 SHA512:
-  metadata.gz: 651394118662adddc2c3a75fa986e92c6d6512c42b6b12a0bbfd1a4a285ba081484f0ec2f25f29107f5bef57994cc7670a8f47000644f450851e1e507dd477d0
-  data.tar.gz: ab362a64ae4119711fe172d93554a86234df3cd24be0b91390c1f5e5db5aee8d5f7bd59f8c42dc7d0ccec6dba66ab63f0807c37421fc226b23d0a0f08cf8eddc
+  metadata.gz: 61a8b2704956521264d34c0668654ff4d38dc697e135bfce165f535553b6d4b6e67fd1d95dff1f4848d0085013312b04e3b6ba8a8475e2717035834644e7548d
+  data.tar.gz: 9becf310f2aa4bed72aa9bfeff3d519e5c49356d21976e57dea3f17e859899f51ae69f19a3340b3d98fa65c6e7c9871a2f35199fabe571f8d0da888bf3ff10ba

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 *.gem
+.ruby-version

data/README.md

@@ -1,6 +1,6 @@
 # MTIF
 
-A gem to read Movable Type Import Format
+A gem to read Movable Type Import Format, as documented at [TypePad.org](https://movabletype.org/documentation/appendices/import-export-format.html) and also in the [Wayback Machine](https://web.archive.org/web/20210105063407/https://movabletype.org/documentation/appendices/import-export-format.html)
 
 ## Installation
 
@@ -20,10 +20,21 @@ Or install it yourself as:
 
 ## Usage
 
-
+Boy, it'd be smart to put something here. One day I will. Or maybe you will? See "Contributing" below.
 
 ## Contributing
 
+[![Build Status](https://travis-ci.org/purp/mtif.svg?branch=master)](https://travis-ci.org/purp/mtif) [![Maintainability](https://api.codeclimate.com/v1/badges/a52b50316f369a5baa8f/maintainability)](https://codeclimate.com/github/purp/mtif/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/a52b50316f369a5baa8f/test_coverage)](https://codeclimate.com/github/purp/mtif/test_coverage)
+
+Looking to get involved but don't have a particular itch to scratch? There are plenty of other ways to help!
+
+* A bit of documentation
+* A tutorial to help someone else along
+* More test coverage
+* Improving the overall code health by addressing Code Climate issues
+
+Meanwhile, you can get started the usual way:
+
 1. Fork it ( https://github.com/[my-github-username]/mtif/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/Rakefile

@@ -1,2 +1,11 @@
 require "bundler/gem_tasks"
 
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/mtif.rb

@@ -9,12 +9,12 @@ class MTIF
   def initialize(content)
     @posts = content.slice_after(/^--------$/).map {|raw_post| MTIF::Post.new(raw_post)}
   end
-  
+
   def self.load_file(filename)
     mtif_file = File.open(filename)
     mtif = MTIF.new(mtif_file.readlines)
     mtif_file.close
-    
+
     mtif
   end
 

data/lib/mtif/posts.rb

@@ -3,17 +3,19 @@ require "time"
 class MTIF
   class Post
     attr_accessor :source, :data
-  
+
     SINGLE_VALUE_KEYS = %w(author title status basename date unique_url body extended_body excerpt
-    keywords allow_comments allow_pings convert_breaks no_entry).map(&:to_sym)
-  
+    keywords allow_comments allow_pings convert_breaks no_entry primary_category).map(&:to_sym)
     MULTILINE_KEYS = %w(body extended_body excerpt keywords comment ping).map(&:to_sym)
-  
-    MULTIVALUE_KEYS = %w(category tag comment ping).map(&:to_sym)
-    
+    MULTIVALUE_KEYS = %w(category tags comment ping).map(&:to_sym)
+    CSV_KEYS = %w(tags).map(&:to_sym)
+
     VALID_KEYS = (SINGLE_VALUE_KEYS + MULTILINE_KEYS + MULTIVALUE_KEYS).sort.uniq
 
     DATE_FORMAT = "%m/%d/%Y %I:%M:%S %p"
+    
+    FIELD_SEPARATOR = '-----'
+    POST_SEPARATOR = '--------'
 
     def valid_keys
       VALID_KEYS
@@ -42,14 +44,14 @@ class MTIF
     def initialize(content)
       @source = content
       @data = {}
-    
+
       MULTIVALUE_KEYS.each do |key|
         @data[key] = []
       end
-    
+
       parse_source
     end
-  
+
     def to_mtif
       result = []
       single_line_single_value_keys.each do |key|
@@ -63,6 +65,14 @@ class MTIF
         values = self.send(key)
         next if values.nil? || (values.respond_to?(:empty) && values.empty?)
 
+        if CSV_KEYS.include?(key)
+          values = [
+            values.map{|v|
+              v.include?("\s") ? "\"#{v}\"" : v
+            }.join(',')
+          ]
+        end
+
         values.each do |value|
           result << "#{mtif_key(key)}: #{mtif_value(value)}"
         end
@@ -72,23 +82,23 @@ class MTIF
         value = self.send(key)
         next if value.nil? || (value.respond_to?(:empty) && value.empty?)
 
-        result << '-----'
+        result << FIELD_SEPARATOR
         result << "#{mtif_key(key)}:\n#{mtif_value(value)}"
       end
-    
+
       multiline_multivalue_keys.each do |key|
         values = self.send(key)
         next if values.nil? || (values.respond_to?(:empty) && values.empty?)
 
         values.each do |value|
-          result << '-----'
+          result << FIELD_SEPARATOR
           result << "#{mtif_key(key)}:\n#{mtif_value(value)}"
         end
       end
 
 
-      result << '-----' unless result.last == '-----' #close the final field
-      result << '--------' # close the post
+      result << FIELD_SEPARATOR unless result.last == FIELD_SEPARATOR #close the final field
+      result << POST_SEPARATOR # close the post
       result.join("\n") + "\n"
     end
 
@@ -97,7 +107,7 @@ class MTIF
       key = method.to_s.chomp('=').to_sym
 
       if valid_key?(key)
-        if key = method
+        if key == method
           data[key]
         else
           data[key] = args.first
@@ -116,7 +126,7 @@ class MTIF
     def mtif_key_to_key(raw_key)
       raw_key.strip.downcase.tr(' ','_').to_sym unless raw_key.nil?
     end
-  
+
     def mtif_key(key)
       key.to_s.tr('_', ' ').upcase
     end
@@ -135,21 +145,27 @@ class MTIF
         raw_value
       end
     end
-  
+
     def store_data(raw_key, raw_value)
       key = mtif_key_to_key(raw_key)
       value = convert_to_native_type(raw_value)
 
       if MULTIVALUE_KEYS.include?(key)
-        self.data[key] << value unless value.empty?
+        if CSV_KEYS.include?(key)
+          value.split(',').each do |v|
+            self.data[key] << v.gsub(/^\"|\"$/, '') unless v.empty?
+          end
+        else
+          self.data[key] << value unless value.empty?
+        end
       else
         self.data[key] = value
       end
     end
 
     def parse_source
-      source.slice_before(/-----/).each do |lines|
-        if lines.first =~ /^-----/ && lines.size > 1
+      source.slice_before(/^#{FIELD_SEPARATOR}/).each do |lines|
+        if lines.first =~ /^#{FIELD_SEPARATOR}/ && lines.size > 1
           # Multiline data
           store_data(lines.shift(2).last.chomp(":\n"), lines.join.strip)
         elsif lines.first =~ /^[A-Z ]+: /

data/lib/mtif/version.rb

@@ -1,3 +1,3 @@
 class MTIF
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mtif.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
 end

data/spec/mtif/post_spec.rb

@@ -3,7 +3,7 @@ RSpec.describe MTIF::Post do
     expect(MTIF::Post.new([])).to respond_to(:source, :data)
   end
   
-  context 'valid keys' do
+  describe 'class constants' do
     it 'should have a list of valid single-value keys' do
       expect(MTIF::Post).to have_constant('SINGLE_VALUE_KEYS')
       expect(MTIF::Post::SINGLE_VALUE_KEYS).not_to be_empty
@@ -27,104 +27,112 @@ RSpec.describe MTIF::Post do
       expect(MTIF::Post).to have_constant('VALID_KEYS')
       expect(MTIF::Post::VALID_KEYS).to match_array((MTIF::Post::SINGLE_VALUE_KEYS + MTIF::Post::MULTILINE_KEYS + MTIF::Post::MULTIVALUE_KEYS).uniq)
     end
-    
-    context 'key methods' do
-      before :each do
-        @post = MTIF::Post.new([])
+  end
+
+  describe 'instances' do
+    subject(:post) {MTIF::Post.new([])}
+
+    it {should respond_to(:valid_keys)}
+    context '#valid_keys' do
+      subject {post.valid_keys}
+        
+      it {should == MTIF::Post::VALID_KEYS}
+    end
+
+    it {should respond_to(:valid_key?)}
+    describe '#valid_key?' do
+      context 'given a valid key' do
+        subject(:valid_key) {post.valid_keys.first}
+        
+        it 'should be true' do
+          expect(post.valid_key?(valid_key)).to be_truthy
+        end
       end
       
-      subject {@post}
-
-      it {should respond_to(:valid_keys)}
-      context '#valid_keys' do
-        subject {@post.valid_keys}
+      context 'given a valid key name as a string' do
+        subject(:valid_key) {post.valid_keys.first.to_s}
         
-        it {should == MTIF::Post::VALID_KEYS}
+        it 'should be true' do
+          expect(post.valid_key?(valid_key)).to be_truthy
+        end
       end
+      
+      context 'given an invalid key' do
+        subject(:invalid_key) {post.valid_keys.first.to_s.reverse.to_sym}
 
-      it {should respond_to(:valid_key?)}
-      context '#valid_key?' do
-        it 'should be true when valid, false otherwise' do
-          valid_key = @post.valid_keys.first.to_sym
-          invalid_key = valid_key.to_s.reverse.to_sym
-
-          expect(@post.valid_key?(valid_key)).to be_truthy
-          expect(@post.valid_key?(valid_key.to_s)).to be_truthy
-          expect(@post.valid_key?(invalid_key)).to be_falsey
-          expect(@post.valid_key?(invalid_key.to_s)).to be_falsey
+        it 'should be false' do
+          expect(post.valid_key?(invalid_key)).to be_falsey
         end
       end
+    end
 
-      context 'returning lists' do
-        it {should respond_to(:single_line_single_value_keys)}
-        context '#single_line_single_value_keys' do
-          subject {@post.single_line_single_value_keys}
+    it {should respond_to(:single_line_single_value_keys)}
+    describe '#single_line_single_value_keys' do
+      subject {post.single_line_single_value_keys}
           
-          it {should_not include(*MTIF::Post::MULTILINE_KEYS)}
-          it {should_not include(*MTIF::Post::MULTIVALUE_KEYS)}
-          it {should include(*(MTIF::Post::SINGLE_VALUE_KEYS - MTIF::Post::MULTILINE_KEYS))}
-        end
+      it {should_not include(*MTIF::Post::MULTILINE_KEYS)}
+      it {should_not include(*MTIF::Post::MULTIVALUE_KEYS)}
+      it {should include(*(MTIF::Post::SINGLE_VALUE_KEYS - MTIF::Post::MULTILINE_KEYS))}
+    end
 
-        it {should respond_to(:single_line_multivalue_keys)}
-        context '#single_line_multivalue_keys' do
-          subject {@post.single_line_multivalue_keys}
+    it {should respond_to(:single_line_multivalue_keys)}
+    describe '#single_line_multivalue_keys' do
+      subject {post.single_line_multivalue_keys}
           
-          it {should_not include(*MTIF::Post::MULTILINE_KEYS)}
-          it {should_not include(*MTIF::Post::SINGLE_VALUE_KEYS)}
-          it {should include(*(MTIF::Post::MULTIVALUE_KEYS - MTIF::Post::MULTILINE_KEYS))}
-        end
+      it {should_not include(*MTIF::Post::MULTILINE_KEYS)}
+      it {should_not include(*MTIF::Post::SINGLE_VALUE_KEYS)}
+      it {should include(*(MTIF::Post::MULTIVALUE_KEYS - MTIF::Post::MULTILINE_KEYS))}
+    end
 
-        it {should respond_to(:multiline_single_value_keys)}
-        context '#multiline_single_value_keys' do
-          subject {@post.multiline_single_value_keys}
+    it {should respond_to(:multiline_single_value_keys)}
+    describe '#multiline_single_value_keys' do
+      subject {post.multiline_single_value_keys}
           
-          it {should_not include(*MTIF::Post::MULTIVALUE_KEYS)}
-          it {should include(*(MTIF::Post::MULTILINE_KEYS & MTIF::Post::SINGLE_VALUE_KEYS))}
-        end
+      it {should_not include(*MTIF::Post::MULTIVALUE_KEYS)}
+      it {should include(*(MTIF::Post::MULTILINE_KEYS & MTIF::Post::SINGLE_VALUE_KEYS))}
+    end
 
-        it {should respond_to(:multiline_multivalue_keys)}
-        context '#multiline_multivalue_keys' do
-          subject {@post.multiline_multivalue_keys}
+    it {should respond_to(:multiline_multivalue_keys)}
+    describe '#multiline_multivalue_keys' do
+      subject {post.multiline_multivalue_keys}
 
-          it {should_not include(*MTIF::Post::SINGLE_VALUE_KEYS)}
-          it {should include(*(MTIF::Post::MULTILINE_KEYS & MTIF::Post::MULTIVALUE_KEYS))}
-        end
-      end
+      it {should_not include(*MTIF::Post::SINGLE_VALUE_KEYS)}
+      it {should include(*(MTIF::Post::MULTILINE_KEYS & MTIF::Post::MULTIVALUE_KEYS))}
     end
-  end
-
-  context 'fetching data' do
-    subject {MTIF::Post.new([])}
     
-    MTIF::Post::VALID_KEYS.each do |key|
-      it {should respond_to(key)}
-      it {should respond_to("#{key}=")}
-    end
-
-    it {should_not respond_to(:this_is_not_a_valid_key)}
-    it {should_not respond_to(:this_is_not_a_valid_key=)}
+    describe '#method_missing' do
+      context 'acting as an attribute accessor for valid keys only' do
+        MTIF::Post::VALID_KEYS.each do |key|
+          it {should respond_to(key)}
+          it {should respond_to("#{key}=")}
+        end
 
-    it 'should default to arrays for multivalue keys' do
-      post = MTIF::Post.new([])
+        it {should_not respond_to(:this_is_not_a_valid_key)}
+        it {should_not respond_to(:this_is_not_a_valid_key=)}
 
-      MTIF::Post::MULTIVALUE_KEYS.each do |key|
-        expect(post.send(key)) == []
+        it 'should return arrays for multivalue keys by default' do
+          MTIF::Post::MULTIVALUE_KEYS.each do |key|
+            expect(post.send(key)) == []
+          end
+        end
       end
     end
   end
-  
-  context '#to_mtif' do
+
+  describe 'instances with content' do
     before :each do
-      # TODO: refactor to remove ordering dependency
       @content = [
-        "AUTHOR: The Meyer Kids\n",
-        "TITLE: Crazy Parents: A Primer\n",
+        "AUTHOR: The ----- Meyer Kids\n",
+        "TITLE: Crazy Parents: -------- A Primer\n",
         "DATE: 06/19/1999 07:00:00 PM\n",
         "ALLOW COMMENTS: 0\n",
+        "PRIMARY CATEGORY: Fun!\n",
         "CATEGORY: Fun!\n",
+        "CATEGORY: More Fun!\n",
+        "TAGS: \"Movable Type\",foo,bar\n",
         "-----\n",
         "BODY:\n",
-        "Start singing an obnoxious song and never stop.\n",
+        "Start singing an obnoxious song and ----- never ----- stop.\n",
         "-----\n",
         "COMMENT:\n",
         "AUTHOR: Jim Meyer\n",
@@ -136,14 +144,48 @@ RSpec.describe MTIF::Post do
         "-----\n",
         "--------\n"
       ]
-
-      @post = MTIF::Post.new(@content)
     end
     
-    it 'should return concise MTIF containing only keys which are set' do
-      expect(@post).to respond_to(:to_mtif)
-      expect(@post.to_mtif).to eq(@content.join)
+    subject(:post) {MTIF::Post.new(@content)}
+    
+    it 'should correctly parse fields with separator text inside the field' do
+      expect(post.author).to eq("The ----- Meyer Kids")
+      expect(post.title).to eq("Crazy Parents: -------- A Primer")
+      expect(post.body).to eq("Start singing an obnoxious song and ----- never ----- stop.")
+    end
+    
+    it 'should correctly parse tags as comma-separated values' do
+      expect(post.tags).to eq(["Movable Type","foo","bar"])
+    end
+    
+    describe '#method_missing' do
+      it 'should properly update values' do
+        expect(post.allow_comments).not_to eq(1)
+        post.allow_comments = 1
+        expect(post.allow_comments).to eq(1)
+      end
     end
-  end
   
+    describe '#to_mtif' do
+      it {should respond_to(:to_mtif)}
+      it 'should return concise MTIF containing only keys which are set' do
+        # TODO: one day this will break because the hash doesn't join in key order.
+        expect(post.to_mtif).to eq(@content.join)
+      end
+      
+      it 'should include updated values' do
+        post.allow_comments = 1
+        expect(post.to_mtif).to match(/ALLOW COMMENTS: 1/)
+      end
+      
+      it 'should convert tags to comma-separated values with proper quoting' do
+        expect(post.to_mtif).to match(/TAGS: "Movable Type",foo,bar/)
+      end
+      
+      it 'should convert categories to multiple CATEGORY lines' do
+        expect(post.to_mtif).to match(/CATEGORY: Fun!/)
+        expect(post.to_mtif).to match(/CATEGORY: More Fun!/)
+      end
+    end
+  end
 end

data/spec/mtif_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe MTIF do
   context "#initialize" do
     context 'without content' do
       it 'should fail' do
-        expect {MTIF.new}.to raise_error
+        expect {MTIF.new}.to raise_error(ArgumentError)
       end
     end
 

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mtif
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jim Meyer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-26 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jim@geekdaily.org
 executables: []
@@ -90,7 +90,7 @@ homepage: https://geekdaily.org/projects/mtif
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,9 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Read, parse, and write Movable Type Import Format files.
 test_files: