setsumei 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/Gemfile

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

data/README.md

@@ -0,0 +1,4 @@
+Setsumei
+--------
+
+Api description tool to build ruby DSL's from JSON data.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/setsumei.rb

@@ -0,0 +1,2 @@
+require 'setsumei/describable'
+require 'setsumei/build'

data/lib/setsumei/build.rb

@@ -0,0 +1,21 @@
+require 'setsumei/build/key'
+
+module Setsumei
+  module Build
+    def Build.a(klass,options = {})
+      inform_developer "#{klass} should be able to list its attributes" unless klass.respond_to? :defined_attributes
+      inform_developer "wrong number of arguments, options must include from: data }" unless options.keys.include? :from
+
+      klass.new.tap do |object|
+        klass.defined_attributes.each do |_,attribute|
+          attribute.set_value_on object, from_value_in: options[:from]
+        end
+      end
+    end
+
+    private
+      def self.inform_developer(message)
+        raise ArgumentError.new message
+      end
+  end
+end

data/lib/setsumei/build/key.rb

@@ -0,0 +1,28 @@
+module Setsumei
+  module Build
+    class Key
+      def Key.for(name,options = { given: [name] } )
+        possible_keys = options[:given]
+        lower_camel_case(name,possible_keys) || at_symbol_case(name,possible_keys) || upper_camel_case(name,possible_keys)
+      end
+      def Key.lower_camel_case name, keys = nil
+        lower_camel_case = name.to_s.gsub(/_[a-zA-Z]/) { |a| a[1].upcase }
+        return_if lower_camel_case, in: keys
+      end
+      def Key.at_symbol_case name, keys = nil
+        at_symbol_case = "@" + lower_camel_case(name)
+        return_if at_symbol_case, in: keys
+      end
+      def Key.upper_camel_case name, keys = nil
+        lower_camel_case = self.lower_camel_case(name)
+        upper_camel_case = lower_camel_case[0].upcase + lower_camel_case[1..-1]
+        return_if upper_camel_case, in: keys
+      end
+
+      private
+        def self.return_if value, options = { in: [] }
+          (options[:in] || [value]).select { |possible| possible == value }.first
+        end
+    end
+  end
+end

data/lib/setsumei/describable.rb

@@ -0,0 +1,80 @@
+require 'setsumei/describable/boolean_attribute'
+require 'setsumei/describable/string_attribute'
+require 'setsumei/describable/float_attribute'
+require 'setsumei/describable/int_attribute'
+require 'setsumei/describable/object_attribute'
+require 'setsumei/describable/collection'
+
+module Setsumei
+  module Describable
+
+    def Describable.included(other)
+      other.extend DescriptionMethods
+    end
+
+    module DescriptionMethods
+
+      def defined_attributes
+        _defined_attributes.dup
+      end
+
+      def define field_name, options = {}
+        _defined_attributes[field_name] = attribute_type(options[:as_a]).named field_name, options
+        attr_accessor field_name
+      end
+
+      def collection_of klass, options = {}
+        self.class_eval do
+          include Enumerable
+          include Comparable
+
+          def each(*args,&block)
+            _internal_collection.each(*args,&block)
+          end
+
+          def include? value
+            _internal_collection.include? value
+          end
+
+          def <<(value)
+            _internal_collection << value
+          end
+
+          def [](value)
+            _internal_collection[value]
+          end
+
+          def []=(index,value)
+            _internal_collection[index] = value
+          end
+
+          def <=>(other)
+            _internal_collection <=> other || super
+          end
+
+          private
+            def _internal_collection
+              @_internal_collection ||= []
+            end
+        end
+        _defined_attributes[:_self] = Collection.of klass,options
+      end
+
+      private
+        def _defined_attributes
+          (@_defined_attributes ||= {})
+        end
+        def attribute_type(type)
+          case type
+            when :boolean then BooleanAttribute
+            when :string  then StringAttribute
+            when nil      then StringAttribute
+            when :float   then FloatAttribute
+            when :int     then IntAttribute
+          else
+            ObjectAttribute if type.is_a?(Class)
+          end
+        end
+    end
+  end
+end

data/lib/setsumei/describable/boolean_attribute.rb

@@ -0,0 +1,34 @@
+module Setsumei
+  module Describable
+    class BooleanAttribute
+
+      def BooleanAttribute.named(name, options = {})
+        new.tap do |attribute|
+          attribute.name = name
+        end
+      end
+
+      attr_accessor :name
+
+      def is_an_attribute_of_type?(type)
+        type == :boolean || type == self.class
+      end
+
+      def value_for(pre_type_cast_value)
+        pre_type_cast_value.to_s.downcase == "true" || pre_type_cast_value.to_s == "1"
+      end
+
+      def set_value_on(object, options)
+        object.send accessor, value_from_hash(options[:from_value_in])
+      end
+
+      private
+        def accessor
+          :"#{name}="
+        end
+        def value_from_hash(hash)
+          value_for hash[ Build::Key.for name, given: hash.keys ]
+        end
+    end
+  end
+end

data/lib/setsumei/describable/collection.rb

@@ -0,0 +1,20 @@
+module Setsumei
+  module Describable
+    class Collection
+      def Collection.of(klass,options = {})
+        new.tap do |collection|
+          collection.klass = klass
+          collection.options = options
+        end
+      end
+
+      attr_accessor :klass, :options
+
+      def set_value_on(object, options = {})
+        [options[:from_value_in][Build::Key.for((self.options[:within] || klass), given: options[:from_value_in].keys)]].flatten(1).each do |data|
+          object << Build.a(klass, from: data)
+        end
+      end
+    end
+  end
+end

data/lib/setsumei/describable/float_attribute.rb

@@ -0,0 +1,34 @@
+module Setsumei
+  module Describable
+    class FloatAttribute
+
+      def FloatAttribute.named(name, options = {})
+        new.tap do |attribute|
+          attribute.name = name
+        end
+      end
+
+      attr_accessor :name
+
+      def is_an_attribute_of_type?(type)
+        type == :float || type == self.class
+      end
+
+      def value_for(pre_type_cast_value)
+        pre_type_cast_value.to_f
+      end
+
+      def set_value_on(object, options)
+        object.send accessor, value_from_hash(options[:from_value_in])
+      end
+
+      private
+        def accessor
+          :"#{name}="
+        end
+        def value_from_hash(hash)
+          value_for hash[ Build::Key.for name, given: hash.keys ]
+        end
+    end
+  end
+end

data/lib/setsumei/describable/int_attribute.rb

@@ -0,0 +1,33 @@
+module Setsumei
+  module Describable
+    class IntAttribute
+      def IntAttribute.named(name, options = {})
+        new.tap do |attribute|
+          attribute.name = name
+        end
+      end
+
+      attr_accessor :name
+
+      def is_an_attribute_of_type?(type)
+        type == :int || type == self.class
+      end
+
+      def value_for(pre_type_cast_value)
+        pre_type_cast_value.to_f.round
+      end
+
+      def set_value_on(object, options)
+        object.send accessor, value_from_hash(options[:from_value_in])
+      end
+
+      private
+        def accessor
+          :"#{name}="
+        end
+        def value_from_hash(hash)
+          value_for hash[ Build::Key.for name, given: hash.keys ]
+        end
+    end
+  end
+end

data/lib/setsumei/describable/object_attribute.rb

@@ -0,0 +1,41 @@
+module Setsumei
+  module Describable
+    class ObjectAttribute
+
+      def ObjectAttribute.named(name,options = {})
+        raise ArgumentError.new("you must specify what the object is") unless options.has_key? :as_a
+        new.tap do |attribute|
+          attribute.name = name
+          attribute.klass = options[:as_a]
+        end
+      end
+
+      attr_accessor :name, :klass
+
+      def initialize
+        self.klass = Object
+      end
+
+      def value_for(data)
+        return nil if data.nil? || data.empty?
+        Build.a self.klass, from: data
+      end
+
+      def is_an_attribute_of_type?(type)
+        type == :object || type == self.class || type == self.klass
+      end
+
+      def set_value_on(object, options)
+        object.send accessor, value_from_hash(options[:from_value_in])
+      end
+
+      private
+        def accessor
+          :"#{name}="
+        end
+        def value_from_hash(hash)
+          value_for hash[ Build::Key.for name, given: hash.keys ]
+        end
+    end
+  end
+end

data/lib/setsumei/describable/string_attribute.rb

@@ -0,0 +1,33 @@
+module Setsumei
+  module Describable
+    class StringAttribute
+      def StringAttribute.named(name,options = {})
+        new.tap do |attribute|
+          attribute.name = name
+        end
+      end
+
+      attr_accessor :name
+
+      def is_an_attribute_of_type?(type)
+        type == :string || type == self.class
+      end
+
+      def value_for(pre_type_cast_value)
+        pre_type_cast_value.to_s
+      end
+
+      def set_value_on(object, options)
+        object.send accessor, value_from_hash(options[:from_value_in])
+      end
+
+      private
+        def accessor
+          :"#{name}="
+        end
+        def value_from_hash(hash)
+          value_for hash[ Build::Key.for name, given: hash.keys ]
+        end
+    end
+  end
+end

data/lib/setsumei/version.rb

@@ -0,0 +1,3 @@
+module Setsumei
+  VERSION = "0.0.1"
+end

data/setsumei.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "setsumei/version"
+
+Gem::Specification.new do |s|
+  s.name        = "setsumei"
+  s.version     = Setsumei::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jon Rowe"]
+  s.email       = ["hello@jonrowe.co.uk"]
+  s.homepage    = "https://github.com/JonRowe/setsumei"
+  s.summary     = %q{A tool for describing API's as ruby objects}
+  s.description = %q{A tool for describing API's as ruby objects. Currently supports building these objects from JSON}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'json'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'autotest-standalone'
+  s.add_development_dependency 'ruby-debug19'
+end

data/spec/setsumei/build/key_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+module Setsumei
+  module Build
+    describe Key do
+      describe ".for name, given: hash_keys" do
+        let(:hash_keys) { ["otherAttribute","@anotherAttribute","Array","Object"] }
+
+        subject { Key.for :attribute_name, given: hash_keys }
+
+        specify do
+          hash_keys.concat ["AttributeName", "attributeName", "@attributeName"]
+          subject.should == "attributeName"
+        end
+
+        specify do
+          hash_keys.concat ["AttributeName", "@attributeName"]
+          subject.should == "@attributeName"
+        end
+
+        specify do
+          hash_keys.concat ["AttributeName"]
+          subject.should == "AttributeName"
+        end
+      end
+
+      describe "lower_camel_case(name,keys)" do
+        let(:keys) { [] }
+
+        subject { Key.lower_camel_case :attribute_name, keys }
+
+        it "should return lower camelcase named when keys contain name" do
+          keys << "attributeName"
+          subject.should == "attributeName"
+        end
+        it "should return nil when keys do not contain name" do
+          subject.should be_nil
+        end
+
+        context "keys are ommited" do
+          it "should return lower camelcase name" do
+            Key.lower_camel_case(:attribute_name).should == "attributeName"
+          end
+        end
+      end
+
+      describe "upper_camel_case(name,keys)" do
+        let(:keys) { [] }
+
+        subject { Key.upper_camel_case :attribute_name, keys }
+
+        it "should return upper camelcase named when keys contain name" do
+          keys << "AttributeName"
+          subject.should == "AttributeName"
+        end
+        it "should return nil when keys do not contain name" do
+          subject.should be_nil
+        end
+
+        context "keys are ommited" do
+          it "should return upper camelcase name" do
+            Key.upper_camel_case(:attribute_name).should == "AttributeName"
+          end
+        end
+      end
+
+      describe "at_symbol_case(name,keys)" do
+        let(:keys) { [] }
+
+        subject { Key.at_symbol_case :attribute_name, keys }
+
+        it "should return symbol case named when keys contain name" do
+          keys << "@attributeName"
+          subject.should == "@attributeName"
+        end
+        it "should return nil when keys do not contain name" do
+          subject.should be_nil
+        end
+
+        context "keys are ommited" do
+          it "should return at symbol case" do
+            Key.at_symbol_case(:attribute_name).should == "@attributeName"
+          end
+        end
+      end
+    end
+  end
+end