metadata 0.0.2 → 0.0.4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Colin Young
+
+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,53 @@
+# Metadata
+
+![Metadata Build Status from Travis-CI](https://secure.travis-ci.org/colinyoung/metadata.png)
+
+## Usage
+
+```ruby
+class User < ActiveRecord::Base
+  ...
+  metadata do |obj|
+    puts obj.name
+    is a: 'user'
+    with friends: obj.friends.count
+    stop
+  end
+  ...
+end
+```
+    
+Results in
+
+    Joe is a user with 37 friends.
+    
+Why is this useful?
+
+* Translation
+* Other formats
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metadata'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metadata
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/metadata.rb

@@ -0,0 +1,13 @@
+require "metadata/version"
+require "metadata/hook"
+require "metadata/formats"
+
+module Metadata
+  include Hook
+  
+  def self.included(base)
+    base.extend Hook::ClassMethods
+  end
+end
+
+require "metadata/rails/model/active_record" if Rails

data/lib/metadata/formats.rb

@@ -0,0 +1,13 @@
+require 'metadata/formats/base'
+require 'metadata/formats/json'
+require 'metadata/formats/string'
+
+module Metadata
+  module Format
+    
+    def self.named(name, &block)
+      Metadata::Formats.const_get(name.to_s.classify)
+    end
+    
+  end
+end

data/lib/metadata/formats/base.rb

@@ -0,0 +1,50 @@
+module Metadata
+  module Formats
+    class Base
+      include ActionView::Helpers if defined? Rails
+      
+      attr_accessor :output
+      attr_accessor :object
+      
+      def initialize(object, &block)
+        @output = []        
+        @object = object
+        
+        instance_exec(@object, &block)
+      end
+      
+      def puts(str)
+        str = str.capitalize if @output.empty?
+        @output << str
+      end
+      
+      def is(*args)
+      end
+      
+      def was(*args)
+      end
+      
+      def it(*args)
+      end
+      
+      def around(*args)
+      end
+      
+      def about(*args)
+      end
+      
+      def with(*args)
+      end
+      
+      def stop
+      end
+      
+      protected
+      
+      def word(word)
+        word.to_s # @todo Translate
+      end
+      
+    end
+  end
+end

data/lib/metadata/formats/json.rb

@@ -0,0 +1,9 @@
+module Metadata
+  module Formats
+    class JSON < Base
+      def self.output(*args, &block)
+        raise "JSON Not Implemented yet."
+      end
+    end
+  end
+end

data/lib/metadata/formats/string.rb

@@ -0,0 +1,79 @@
+module Metadata
+  module Formats    
+    class String < Base
+      
+      DICTIONARY = {
+        'is' => {
+          present: 'is',
+          past: 'was'
+        }
+      }
+      
+      def initialize(object, &block)
+        @next = {}
+        super(object, &block)
+      end
+      
+      def is(something, tense=:present)
+        something = pairs(something) if something.is_a?(Hash)
+        
+        @output << statement(change_tense(word(:is), tense), something)
+      end
+      
+      def was(something)
+        is(something, :past)
+      end
+      
+      def it(something)
+        something = pairs(something) if something.is_a?(Hash)
+        
+        @output << statement(word(:it), something)
+      end
+      
+      def with(hash)
+        @output << ::String.new.tap do |s|
+          hash.map do |k,v|
+            k = k.to_s
+            k = k.singularize if k.respond_to? :singularize and v == 1
+            s << statement(word(:with), v, k)
+          end
+        end
+      end
+      
+      def stop        
+        @output << "."
+        @next[:capitalize] = true
+      end
+      
+      def around(*args)
+        @output << statement(word(:around), args.first)
+      end
+      
+      def and_
+        @output << word(:and)
+      end
+      
+      def to_s
+        statement(*@output)
+      end
+      
+      private
+      
+      def statement(*args)
+        if @next[:capitalize]
+          args[0] = args[0].to_s.capitalize
+          @next.delete :capitalize
+        end
+        args.join(' ').strip.gsub(' .', '.')
+      end
+      
+      def pairs(something)
+        statement(something.keys.first, something.values.first)
+      end
+      
+      def change_tense(verb, tense)
+        DICTIONARY[verb][tense]
+      end
+    end
+  end
+end

data/lib/metadata/hook.rb

@@ -0,0 +1,22 @@
+module Metadata
+  module Hook
+    
+    def metadata(args={})
+      # Self right now is the object that has metadata on it
+      return if self.class._metadata.nil?
+      
+      options = self.class._metadata.merge(args)
+      format = Metadata::Format.named(options[:format])
+      format.new(self, &options[:block])
+    end
+    
+    module ClassMethods
+      attr_accessor :_metadata
+    
+      def metadata(*args, &block)
+        options = args.first.is_a?(Hash) ? args.first : {}
+        self._metadata = {format: options[:format] || :string, block: block}
+      end
+    end
+  end
+end

data/lib/metadata/rails/model/active_record.rb

@@ -0,0 +1,3 @@
+class ActiveRecord::Base
+  include Metadata
+end

data/lib/metadata/version.rb

@@ -0,0 +1,3 @@
+module Metadata
+  VERSION = "0.0.4"
+end

data/metadata.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/metadata/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Colin Young"]
+  gem.email         = ["me@colinyoung.com"]
+  gem.description   = %q{Generate metadata from any ruby object (works great with rails.)}
+  gem.summary       = %q{Metadata is an easy way to represent an object in a human or machine readable format.}
+  gem.homepage      = "https://github.com/colinyoung/metadata"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "metadata"
+  gem.require_paths = ["lib"]
+  gem.version       = Metadata::VERSION
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metadata
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-30 00:00:00.000000000Z
+date: 2012-10-06 00:00:00.000000000 Z
 dependencies: []
 description: Generate metadata from any ruby object (works great with rails.)
 email:
@@ -17,7 +17,21 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/metadata.rb
+- lib/metadata/formats.rb
+- lib/metadata/formats/base.rb
+- lib/metadata/formats/json.rb
+- lib/metadata/formats/string.rb
+- lib/metadata/hook.rb
+- lib/metadata/rails/model/active_record.rb
+- lib/metadata/version.rb
+- metadata.gemspec
 homepage: https://github.com/colinyoung/metadata
 licenses: []
 post_install_message: 
@@ -38,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Metadata is an easy way to represent an object in a human or machine readable