trundle 0.1.0

data/spec/lib/key_spec.rb

@@ -0,0 +1,53 @@
+RSpec.describe Trundle::Key do
+  describe '#camelize' do
+    it 'does not change a lower case string' do
+      expect(described_class.new('version').camelize).to eq('version')
+    end
+
+    it 'does not change a camelized string' do
+      expect(described_class.new('creatorIdentifier').camelize).to eq('creatorIdentifier')
+    end
+
+    it 'does not change a camelized string with URL at the end' do
+      expect(described_class.new('sourceURL').camelize).to eq('sourceURL')
+    end
+
+    it 'handles a multi word string' do
+      expect(described_class.new('creator_identifier').camelize).to eq('creatorIdentifier')
+    end
+
+    it 'handles a string with URL at the end' do
+      expect(described_class.new('source_url').camelize).to eq('sourceURL')
+    end
+
+    it 'handles a string with URL in the middle' do
+      expect(described_class.new('source_url_original').camelize).to eq('sourceUrlOriginal')
+    end
+  end
+
+  describe '#underscore' do
+    it 'does not change a lower case string' do
+      expect(described_class.new('version').underscore).to eq('version')
+    end
+
+    it 'does not change an underscored string' do
+      expect(described_class.new('creator_identifier').underscore).to eq('creator_identifier')
+    end
+
+    it 'does not change an underscored string with URL at the end' do
+      expect(described_class.new('source_url').underscore).to eq('source_url')
+    end
+
+    it 'handles a multi word string' do
+      expect(described_class.new('creatorIdentifier').underscore).to eq('creator_identifier')
+    end
+
+    it 'handles a string with URL at the end' do
+      expect(described_class.new('sourceURL').underscore).to eq('source_url')
+    end
+
+    it 'handles a string with URL in the middle' do
+      expect(described_class.new('sourceUrlOriginal').underscore).to eq('source_url_original')
+    end
+  end
+end

data/spec/lib/namespace_list_spec.rb

@@ -0,0 +1,21 @@
+RSpec.describe Trundle::NamespaceList do
+  let(:namespace_list) { described_class.new }
+
+  it 'does not include a namespace when it is empty' do
+    expect(namespace_list.include?(:monkey_island)).to be false
+  end
+
+  context 'a namespace has been set' do
+    before do
+      namespace_list.monkey_island('io.monkeyisland')
+    end
+
+    it 'includes the namespace' do
+      expect(namespace_list.include?(:monkey_island)).to be true
+    end
+
+    it 'returns the key' do
+      expect(namespace_list.key(:monkey_island)).to eq('io.monkeyisland')
+    end
+  end
+end

data/spec/lib/text_bundle/info_spec.rb

@@ -0,0 +1,87 @@
+RSpec.describe Trundle::TextBundle do
+  describe 'Info' do
+    let(:text_bundle) { described_class.new(text_bundle_path) }
+
+    describe 'Reading' do
+      let(:text_bundle_path) { 'spec/samples/offical-v2.textbundle' }
+
+      it 'is transient' do
+        expect(text_bundle).to be_transient
+      end
+
+      it 'reads the type' do
+        expect(text_bundle.type).to eq('net.daringfireball.markdown')
+      end
+
+      it 'reads the version' do
+        expect(text_bundle.version).to eq(2)
+      end
+
+      it 'reads the creator URL' do
+        expect(text_bundle.creator_url).to eq('file:///Applications/Example.app/')
+      end
+
+      it 'reads the creator identifier' do
+        expect(text_bundle.creator_identifier).to eq('com.example.editor')
+      end
+
+      it 'reads the source URL' do
+        expect(text_bundle.source_url).to eq('file:///Users/johndoe/Documents/myfile.markdown/')
+      end
+    end
+
+    describe 'Writing' do
+      let(:text_bundle_path) { 'spec/tmp/example.textbundle' }
+
+      it 'writes the transient setting' do
+        text_bundle.transient = false
+        text_bundle.close
+
+        expect(described_class.new(text_bundle_path)).not_to be_transient
+      end
+
+      it 'writes the version' do
+        text_bundle.version = 2
+        text_bundle.close
+
+        expect(described_class.new(text_bundle_path).version).to eq(2)
+      end
+
+      it 'writes the creator URL' do
+        text_bundle.creator_url = 'file:///Applications/Example.app/'
+        text_bundle.close
+
+        expect(described_class.new(text_bundle_path).creator_url).to eq('file:///Applications/Example.app/')
+      end
+
+      it 'writes the creator identifier' do
+        text_bundle.creator_identifier = 'com.example.editor'
+        text_bundle.close
+
+        expect(described_class.new(text_bundle_path).creator_identifier).to eq('com.example.editor')
+      end
+
+      it 'writes the source URL' do
+        text_bundle.source_url = 'file:///Users/johndoe/Documents/myfile.markdown/'
+        text_bundle.close
+
+        expect(described_class.new(text_bundle_path).source_url).to eq('file:///Users/johndoe/Documents/myfile.markdown/')
+      end
+
+      it 'writes the type' do
+        text_bundle.type = 'net.daringfireball.markdown'
+        text_bundle.close
+
+        expect(described_class.new(text_bundle_path).type).to eq('net.daringfireball.markdown')
+      end
+
+      describe '#transient=' do
+        it 'raises an error when the value is not a boolean' do
+          [[], '', nil, {}].each do |value|
+            expect{ text_bundle.transient = value }.to raise_error(ArgumentError, 'transient must be a boolean')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/text_bundle/namespaces_spec.rb

@@ -0,0 +1,67 @@
+RSpec.describe Trundle::TextBundle do
+  describe 'Namespaces' do
+    let(:text_bundle) { described_class.new(text_bundle_path) }
+
+    before do
+      Trundle.configure do |config|
+        config.namespaces do
+          monkey_island 'io.monkeyisland'
+          scabb_island 'io.scabbisland'
+        end
+      end
+    end
+
+    describe 'Reading' do
+      let(:text_bundle_path) { 'spec/samples/namespaces.textbundle' }
+
+      it 'always returns the same namespace object' do
+        expect(text_bundle.monkey_island).to equal(text_bundle.monkey_island)
+        expect(text_bundle.scabb_island).not_to equal(text_bundle.monkey_island)
+      end
+
+      it 'reads attributes from the namespaces' do
+        expect(text_bundle.monkey_island.version).to eq(1)
+        expect(text_bundle.scabb_island.version).to eq(6)
+      end
+
+      it 'reads underscored attributes' do
+        expect(text_bundle.monkey_island.local_castaway).to eq('Herman Toothrot')
+      end
+
+      it 'raises an error if the namespace has not been defined' do
+        message = <<-STRING.gsub(/^ {10}/, '').strip
+          The namespace "melee_island" is not defined!
+
+          Add it to your config using:
+
+          Trundle.configure do |config|
+            config.namespaces do
+              melee_island 'unique.namespace.key'
+            end
+          end
+        STRING
+        expect{ text_bundle.melee_island }.to raise_error(Trundle::NamespaceNotDefined, message)
+      end
+    end
+
+    describe 'Writing' do
+      let(:text_bundle_path) { 'spec/tmp/example.textbundle' }
+
+      it 'writes a value' do
+        text_bundle.monkey_island.version = 9
+        text_bundle.close
+
+        fresh_bundle = described_class.new(text_bundle_path)
+        expect(fresh_bundle.monkey_island.version).to eq(9)
+      end
+
+      it 'writes a value to an underscored attribute' do
+        text_bundle.monkey_island.local_castaway = 'Herman Toothrot'
+        text_bundle.close
+
+        fresh_bundle = described_class.new(text_bundle_path)
+        expect(fresh_bundle.monkey_island.local_castaway).to eq('Herman Toothrot')
+      end
+    end
+  end
+end

data/spec/lib/text_bundle/text_spec.rb

@@ -0,0 +1,26 @@
+RSpec.describe Trundle::TextBundle do
+  describe 'Text' do
+    let(:text_bundle) { described_class.new(text_bundle_path) }
+
+    describe 'Reading' do
+      let(:content) { File.read(text_bundle_path + '/text.markdown') }
+      let(:text_bundle_path) { 'spec/samples/offical-v2.textbundle' }
+
+      it 'reads the text content' do
+        expect(text_bundle.text).to eq(content)
+      end
+    end
+
+    describe 'Writing' do
+      let(:text) { 'Guybrush Threepwood is a mighty pirate. Ish.' }
+      let(:text_bundle_path) { 'spec/tmp/example.textbundle' }
+
+      it 'writes the text content' do
+        text_bundle.text = text
+        text_bundle.close
+
+        expect(described_class.new(text_bundle_path).text).to eq(text)
+      end
+    end
+  end
+end

data/spec/lib/text_bundle_spec.rb

@@ -0,0 +1,81 @@
+RSpec.describe Trundle::TextBundle do
+  let(:text_bundle) { described_class.new(text_bundle_path) }
+
+  describe 'Reading a TextBundle' do
+    let(:text_bundle_path) { 'spec/samples/offical-v2.textbundle' }
+
+    it 'exists' do
+      expect(text_bundle).to exist
+    end
+
+    context 'when configuration options are set' do
+      let(:text_bundle_path) { 'spec/samples/blank.textbundle' }
+
+      before do
+        Trundle.configure do |config|
+          config.version = 3
+        end
+      end
+
+      it 'does not merge in the config' do
+        expect(text_bundle.version).not_to eq(3)
+      end
+    end
+  end
+
+  describe 'Writing a TextBundle' do
+    let(:text_bundle_path) { 'spec/tmp/example.textbundle' }
+
+    it 'does not exist' do
+      expect(text_bundle).not_to exist
+    end
+
+    it 'has no text' do
+      expect(text_bundle.text).to eq('')
+    end
+
+    context 'when closed' do
+      before do
+        text_bundle.close
+      end
+
+      it 'exists' do
+        expect(text_bundle).to exist
+      end
+
+      it 'creates the containing folder' do
+        expect(File.exist?(text_bundle_path)).to be true
+      end
+
+      it 'creates the text file' do
+        expect(File.exist?(text_bundle_path + '/text.markdown')).to be true
+      end
+
+      it 'creates the info file' do
+        expect(File.exist?(text_bundle_path + '/info.json')).to be true
+      end
+    end
+
+    context 'using a block' do
+      let(:text_bundle) do
+        described_class.new(text_bundle_path) {}
+      end
+
+      it 'exists' do
+        expect(text_bundle).to exist
+      end
+    end
+
+    context 'when configuration options are set' do
+      before do
+        Trundle.configure do |config|
+          config.version = 3
+        end
+      end
+
+      it 'merges in the config' do
+        expect(text_bundle.version).to eq(3)
+      end
+    end
+  end
+end

data/spec/lib/trundle_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe Trundle do
+  let(:text_bundle_path) { 'spec/tmp/example.textbundle' }
+
+  describe '.open' do
+    it 'returns an instance' do
+      expect(described_class.open(text_bundle_path)).to be_a(Trundle::TextBundle)
+    end
+
+    context 'using a block' do
+      let(:text_bundle) { described_class.open(text_bundle_path) {} }
+
+      it 'passes down to the new instance' do
+        expect(text_bundle).to exist
+      end
+    end
+  end
+
+  describe '.config' do
+    it 'returns a config object' do
+      expect(Trundle.config).to be_a(Trundle::Config)
+    end
+
+    it 'always returns the same config object' do
+      expect(Trundle.config).to equal(Trundle.config)
+    end
+  end
+
+  describe '.configure' do
+    before do
+      Trundle.configure do |config|
+        config.version = 1
+        config.creator_url = 'http://example.com'
+      end
+    end
+
+    it 'writes config values' do
+      expect(Trundle.config.version).to eq(1)
+      expect(Trundle.config.creator_url).to eq('http://example.com')
+    end
+  end
+end

data/spec/samples/blank.textbundle/info.json

@@ -0,0 +1 @@
+{}

data/spec/samples/namespaces.textbundle/info.json

@@ -0,0 +1,10 @@
+{
+  "version": 2,
+  "io.monkeyisland": {
+    "version": 1,
+    "localCastaway": "Herman Toothrot"
+  },
+  "io.scabbisland": {
+    "version": 6
+  }
+}

data/spec/samples/namespaces.textbundle/text.markdown

@@ -0,0 +1 @@
+

data/spec/samples/offical-v2.textbundle/info.json

@@ -0,0 +1,8 @@
+{
+  "version" : 2,
+  "type": "net.daringfireball.markdown",
+  "transient" : true,
+  "creatorURL" : "file:\/\/\/Applications\/Example.app\/",
+  "creatorIdentifier" : "com.example.editor",
+  "sourceURL": "file:\/\/\/Users\/johndoe\/Documents\/myfile.markdown\/"
+}

data/spec/samples/offical-v2.textbundle/text.markdown

@@ -0,0 +1,5 @@
+# Textbundle Example
+
+This is a simple example of a textbundle package. The following paragraph contains an example of a referenced image using the embedding code `![](assets/textbundle.png)`.
+
+![](assets/textbundle.png)

data/spec/spec_helper.rb

@@ -0,0 +1,108 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'trundle'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    # config.default_formatter = 'doc'
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Keep the spec/tmp directory clean
+  config.before(:each) do
+    clean_up_tmp_text_bundles
+  end
+
+  config.after(:each) do
+    reset_config
+    clean_up_tmp_text_bundles
+  end
+
+  def reset_config
+    Trundle.remove_instance_variable(:@config) if Trundle.instance_variable_defined?(:@config)
+  end
+
+  def clean_up_tmp_text_bundles
+    FileUtils.rm_rf Dir.glob('spec/tmp/*.textbundle'), secure: true
+  end
+end

data/trundle.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trundle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'trundle'
+  spec.version       = Trundle::VERSION
+  spec.authors       = ['Andy Pearson']
+  spec.email         = ['andy@andy-pearson.com']
+  spec.summary       = %q{A gem for reading and writing TextBundle files.}
+  spec.description   = %q{A gem for reading and writing TextBundle files.}
+  spec.homepage      = 'https://github.com/andypearson/trundle'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+end