trundle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f26381e6daf38ba9ec6a3e756ce71e4cffba2fc
+  data.tar.gz: f9a7f0c9858604929a667f6f1cd13e3f5be21542
+SHA512:
+  metadata.gz: 2db5e7d5058d0b4e380afe0d9931b1d067ee56c145349c5c4246dc82acf2e575bfceea6103ab1fe8e7a7faddeb5ac4c10e756c7fcdbbd3816f281a0211eb164b
+  data.tar.gz: 34973269859c359dd0a4ead77bda5b940f19a264e1d3827b6b9ace03906ad1cbeae87e3a0c471e0ab5b39994f86a89118b2cfaa6ed18090d8e39d76a249d16e0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trundle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Andy Pearson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,170 @@
+# trundle
+
+A gem for reading and writing [TextBundle](http://textbundle.org/) files.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trundle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trundle
+
+
+## Usage
+
+### Reading an existing TextBundle
+
+Imagine you've got a TextBundle file saved at `~/example-bundle.textbundle`
+
+You can open that very easily with just:
+
+```ruby
+example = Trundle.open('~/example-bundle.textbundle')
+```
+
+That'll give you an instance of a `Trundle::TextBundle` and you'll be able to read out the text content of the bundle using:
+
+```ruby
+example.text
+```
+
+You can also access all of the core attributes outlined in the specification:
+
+```ruby
+example.creator_identifier
+example.creator_url
+example.source_url
+example.type
+example.version
+```
+
+As well as finding out if this TextBundle is transient or not:
+
+```ruby
+example.transient?
+```
+
+### Writing a TextBundle
+
+Now imagine you'd like to create a new TextBundle, you can do that by opening a file where one does not already exist (just as you usually do in Ruby)
+
+```ruby
+my_example = Trundle.open('~/my-example-bundle.textbundle')
+```
+
+Setting the text content of this bundle is as easy as:
+
+```ruby
+my_example.text = 'This is my bundle!'
+```
+
+And you can set the values in a similar way:
+
+```ruby
+example.creator_identifier = 'com.my-app'
+example.creator_url = 'http://my-app.com'
+example.source_url = 'http://my-app.com'
+example.type = 'net.daringfireball.markdown'
+example.version = 2
+example.transient = false
+```
+
+Once you're happy with the state of your new TextBundle you can save it to the filesystem by calling:
+
+```ruby
+example.close
+```
+
+Passing a block to `Trundle.open` will set values and write the bundle in one fell swoop:
+
+```ruby
+Trundle.open('~/my-example-bundle.textbundle') do |tb|
+  tb.text = 'This is my bundle!'
+  tb.source_url = 'http://my-app.com'
+end
+```
+
+
+### Setting up default values
+
+Setting up your new TextBundles over and over again can get pretty boring. Instead, you can set up defaults that'll apply to any TextBundle that you create:
+
+```ruby
+Trundle.configure do |config|
+  config.creator_identifier = 'com.my-app'
+  config.creator_url = 'http://my-app.com'
+  config.source_url = 'http://my-app.com'
+  config.type = 'net.daringfireball.markdown'
+  config.version = 2
+  config.transient = false
+end
+```
+
+Out of the box, trundle is setup with the following defaults:
+
+```ruby
+Trundle.configure do |config|
+  config.version = 2
+  config.transient = false
+end
+```
+
+
+### Working with namespaces
+
+Applications can add custom meta data to any TextBundle by including it under a unique application key. In Trundle, this is called a namespace.
+
+You need to tell trundle about the namespaces that you'd like to work with. You can do that in the config:
+
+```ruby
+Trundle.configure do |config|
+  config.namespaces do
+    my_app 'com.my-app'
+  end
+end
+```
+
+The bit on the left defines the name of the accessor method and the bit on the right is the application key that'll be read and written. You can setup as many namespaces as you need.
+
+Once trundle knows about your namespaces, you can read custom values from them:
+
+```ruby
+existing_document = Trundle.open('~/document.textbundle')
+existing_document.my_app.version
+existing_document.my_app.document_type
+```
+
+And also write custom values too:
+
+```ruby
+my_document = Trundle.open('~/my-document.textbundle')
+my_document.my_app.version = 42
+my_document.my_app.document_type = 'Article'
+my_document.close
+```
+
+
+## Next things
+
+- TODO: rubocop the code
+- TODO: add support for assets
+- TODO: could the configuration DSL be more succinct?
+- TODO: default values for namespaces?
+
+## Contributing
+
+1. Fork it ( https://github.com/andypearson/trundle/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/trundle/config.rb

@@ -0,0 +1,61 @@
+class Trundle::Config
+  attr_accessor(
+    :creator_identifier,
+    :creator_url,
+    :source_url,
+    :transient,
+    :type,
+    :version
+  )
+
+  def initialize
+    @version = 2
+    @transient = false
+  end
+
+  def namespace?(name)
+    namespace_list.include?(name)
+  end
+
+  def namespace_key(name)
+    namespace_list.key(name)
+  end
+
+  def namespaces(&block)
+    if block_given?
+      namespace_list.instance_eval(&block)
+    else
+      namespace_list.all
+    end
+  end
+
+  def transient=(value)
+    raise ArgumentError, 'transient must be a boolean' unless !!value == value
+    @transient = value
+  end
+
+  def to_h
+    hash = {}
+    keys.each do |key|
+      value = send(key)
+      hash[Trundle::Key.new(key).camelize] = value if !value.nil?
+    end
+    hash
+  end
+
+  private
+  def keys
+    [
+      :creator_identifier,
+      :creator_url,
+      :source_url,
+      :transient,
+      :type,
+      :version
+    ]
+  end
+
+  def namespace_list
+    @namespace_list ||= Trundle::NamespaceList.new
+  end
+end

data/lib/trundle/info_accessors.rb

@@ -0,0 +1,15 @@
+module Trundle::InfoAccessors
+  def info_accessors(*args)
+    args.each do |arg|
+      key = Trundle::Key.new(arg).camelize
+
+      define_method(arg) do
+        info[key]
+      end
+
+      define_method("#{arg}=") do |value|
+        info[key] = value
+      end
+    end
+  end
+end

data/lib/trundle/info_store.rb

@@ -0,0 +1,23 @@
+require 'json'
+
+class Trundle::InfoStore
+  def initialize(path)
+    @path = path
+  end
+
+  def content=(value)
+    @content = value
+  end
+
+  def content
+    @content ||= JSON.parse(File.read(@path))
+  rescue Errno::ENOENT
+    @content = {}
+  end
+
+  def write
+    File.open(@path, 'w') do |file|
+      file.write(JSON.pretty_generate(content))
+    end
+  end
+end

data/lib/trundle/key.rb

@@ -0,0 +1,15 @@
+require 'active_support/inflector'
+
+class Trundle::Key
+  def initialize(key)
+    @key = key.to_s
+  end
+
+  def camelize
+    ActiveSupport::Inflector.camelize(@key, false).gsub(/url$/i, 'URL')
+  end
+
+  def underscore
+    ActiveSupport::Inflector.underscore(@key)
+  end
+end

data/lib/trundle/namespace_list.rb

@@ -0,0 +1,21 @@
+class Trundle::NamespaceList
+  def initialize
+    @namespaces = {}
+  end
+
+  def include?(name)
+    @namespaces.has_key? name.to_sym
+  end
+
+  def key(name)
+    @namespaces[name.to_sym]
+  end
+
+  def all
+    @namespaces
+  end
+
+  def method_missing(name, *args, &block)
+    @namespaces[name.to_sym] = args[0]
+  end
+end

data/lib/trundle/namespaced_attributes.rb

@@ -0,0 +1,23 @@
+class Trundle::NamespacedAttributes < OpenStruct
+  def initialize(attributes = {})
+    super(normalize_attributes(attributes))
+  end
+
+  def to_h
+    attrs = {}
+    super.to_h.each do |key, value|
+      attrs[Trundle::Key.new(key).camelize] = value
+    end
+    attrs
+  end
+
+  private
+  def normalize_attributes(attributes)
+    normalized_attributes = {}
+    attributes.each do |key, value|
+      key = Trundle::Key.new(key).underscore
+      normalized_attributes[key] = value
+    end
+    normalized_attributes
+  end
+end

data/lib/trundle/text_bundle.rb

@@ -0,0 +1,95 @@
+class Trundle::TextBundle
+  extend Trundle::InfoAccessors
+
+  info_accessors(
+    :creator_identifier,
+    :creator_url,
+    :source_url,
+    :transient,
+    :type,
+    :version
+  )
+
+  def initialize(path)
+    @path = path
+    @info_store = Trundle::InfoStore.new(File.join(@path, 'info.json'))
+    @text_store = Trundle::TextStore.new(File.join(@path, 'text.markdown'))
+
+    @info_store.content = Trundle.config.to_h unless exist?
+
+    if block_given?
+      yield(self)
+      close
+    end
+  end
+
+  def exist?
+    File.exist?(@path)
+  end
+
+  def text
+    @text_store.content
+  end
+
+  def text=(value)
+    @text_store.content = value
+  end
+
+  def close
+    Dir.mkdir(@path) unless exist?
+    write_namespaces
+    @info_store.write
+    @text_store.write
+  end
+
+  def transient=(value)
+    raise ArgumentError, 'transient must be a boolean' unless !!value == value
+    info['transient'] = value
+  end
+
+  def transient?
+    !!info['transient']
+  end
+
+  def method_missing(name, *args, &block)
+    if Trundle.config.namespace?(name)
+      namespaced_attributes_for(name)
+    else
+      raise Trundle::NamespaceNotDefined, namespace_not_defined_message(name)
+    end
+  end
+
+  private
+  def info
+    @info_store.content
+  end
+
+  def namespaced_attributes_for(name)
+    var = "@#{name}"
+    if !instance_variable_defined?(var)
+      attributes = info[Trundle.config.namespace_key(name)] || {}
+      instance_variable_set(var, Trundle::NamespacedAttributes.new(attributes))
+    end
+    instance_variable_get(var)
+  end
+
+  def write_namespaces
+    Trundle.config.namespaces.each do |name, key|
+      info[key] = namespaced_attributes_for(name).to_h
+    end
+  end
+
+  def namespace_not_defined_message(name)
+    <<-STRING.gsub(/^ {6}/, '').strip
+      The namespace "#{name}" is not defined!
+
+      Add it to your config using:
+
+      Trundle.configure do |config|
+        config.namespaces do
+          #{name} 'unique.namespace.key'
+        end
+      end
+    STRING
+  end
+end

data/lib/trundle/text_store.rb

@@ -0,0 +1,19 @@
+class Trundle::TextStore
+  attr_writer :content
+
+  def initialize(path)
+    @path = path
+  end
+
+  def content
+    @content ||= File.read(@path)
+  rescue
+    @content = ''
+  end
+
+  def write
+    File.open(@path, 'w') do |file|
+      file.write(content)
+    end
+  end
+end

data/lib/trundle/version.rb

@@ -0,0 +1,3 @@
+class Trundle
+  VERSION = '0.1.0'
+end

data/lib/trundle.rb

@@ -0,0 +1,31 @@
+require 'trundle/version'
+require 'trundle/info_accessors'
+
+require 'trundle/config'
+require 'trundle/info_store'
+require 'trundle/key'
+require 'trundle/namespace_list'
+require 'trundle/namespaced_attributes'
+require 'trundle/text_bundle'
+require 'trundle/text_store'
+
+class Trundle
+
+  class NamespaceNotDefined < StandardError; end
+
+  def self.open(path)
+    if block_given?
+      TextBundle.new(path, &Proc.new)
+    else
+      TextBundle.new(path)
+    end
+  end
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,113 @@
+RSpec.describe Trundle::Config do
+  let(:config) { described_class.new }
+
+  it 'has a default version' do
+    expect(config.version).to eq(2)
+  end
+
+  it 'is not transient by default' do
+    expect(config.transient).to be false
+  end
+
+  describe 'version' do
+    let(:version) { 1 }
+
+    before do
+      config.version = version
+    end
+
+    it 'is set' do
+      expect(config.version).to eq(version)
+    end
+
+    it 'is included in the hash' do
+      expect(config.to_h).to include('version' => version)
+    end
+  end
+
+  describe 'type' do
+    let(:type) { 'net.daringfireball.markdown' }
+
+    before do
+      config.type = type
+    end
+
+    it 'is set' do
+      expect(config.type).to eq(type)
+    end
+
+    it 'is included in the hash' do
+      expect(config.to_h).to include('type' => type)
+    end
+  end
+
+  describe 'transient' do
+    let(:transient) { true }
+
+    before do
+      config.transient = transient
+    end
+
+    it 'is set' do
+      expect(config.transient).to eq(transient)
+    end
+
+    it 'is included in the hash' do
+      expect(config.to_h).to include('transient' => transient)
+    end
+
+    it 'raises an error when the value is not a boolean' do
+      [[], '', nil, {}].each do |value|
+        expect{ config.transient = value }.to raise_error(ArgumentError, 'transient must be a boolean')
+      end
+    end
+  end
+
+  describe 'creator_url' do
+    let(:creator_url) { 'file:///Applications/MyApp' }
+
+    before do
+      config.creator_url = creator_url
+    end
+
+    it 'is set' do
+      expect(config.creator_url).to eq(creator_url)
+    end
+
+    it 'is included in the hash' do
+      expect(config.to_h).to include('creatorURL' => creator_url)
+    end
+  end
+
+  describe 'creator_identifier' do
+    let(:creator_identifier) { 'com.example.myapp' }
+
+    before do
+      config.creator_identifier = creator_identifier
+    end
+
+    it 'is set' do
+      expect(config.creator_identifier).to eq(creator_identifier)
+    end
+
+    it 'is included in the hash' do
+      expect(config.to_h).to include('creatorIdentifier' => creator_identifier)
+    end
+  end
+
+  describe 'source_url' do
+    let(:source_url) { 'file:///Users/johndoe/Documents/mytext.markdown' }
+
+    before do
+      config.source_url = source_url
+    end
+
+    it 'is set' do
+      expect(config.source_url).to eq(source_url)
+    end
+
+    it 'is included in the hash' do
+      expect(config.to_h).to include('sourceURL' => source_url)
+    end
+  end
+end