rd3 0.0.1

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--backtrace
+--default_path spec

data/.rvmrc

@@ -0,0 +1,71 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.3@rd3"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+#
+# The variable PROJECT_JRUBY_OPTS requires the following to be run in shell:
+#
+#    chmod +x ${rvm_path}/hooks/after_use_jruby_opts
+#
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && ! command -v bundle >/dev/null
+# then
+#   printf "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && command -v bundle
+# then
+#   bundle install
+# fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else 
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi
+

data/.simplecov

@@ -0,0 +1,5 @@
+# configure code coverage
+SimpleCov.start do
+  # exclude directories and files
+  add_filter "/spec/"
+end

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'activesupport'
+gem 'activemodel'
+gem 'require_all'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+  gem "rspec", ">= 2.12.0"
+  gem "simplecov", ">= 0.7.1"
+  gem "mysql2", ">= 0.3.11"
+  gem "pg", ">= 0.14.1"
+  gem "sequel", ">= 3.41.0"
+  gem "waz-storage", ">= 1.1.4"
+  gem "database_cleaner", ">= 0.9.1"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 obie quelland
+
+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,4 @@
+D3
+=====
+
+TODO: update content

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rd3"
+  gem.homepage = "http://github.com/obieq/rd3"
+  gem.license = "MIT"
+  gem.summary = %Q{RD3 is a ruby gem that adheres to and facilitates domain driven design principles}
+  gem.description = %Q{ enable domain driven design approach via POROs and Repositories vs Rails' ActiveRecord }
+  gem.email = "quelland@gmail.com"
+  gem.authors = ["obie quelland"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rd3 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Get spec rake tasks working in RSpec 2.0
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+end
+
+RSpec::Core::RakeTask.new(:fast) do |t|
+  t.rspec_opts = '--tag ~speed:slow'
+end
+
+RSpec::Core::RakeTask.new(:slow) do |t|
+  t.rspec_opts = '--tag speed:slow'
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rd3.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'active_model'
+require 'require_all'
+
+require 'rd3/model'
+require 'rd3/repository'
+require 'rd3/configuration'
+require_rel '../lib/rd3/data_providers'
+require 'rd3/railtie' if defined?(Rails)
+#require 'active_support'
+#require 'active_model'
+
+#require 'rd3/railtie' if defined?(Rails)
+#require_rel '../lib' #.reject {|f| railtie.rb}
+
+module RD3
+  class << self
+    attr_reader :config
+  end
+
+  def self.configure(args)
+    configuration = nil
+    unless args.nil? || args.empty?
+      configuration = RD3::Configuration.new
+      configuration.environment = args[:environment]
+      configuration.config_file_directory = args[:config_file_directory]
+      configuration.enable_logical_deletes = args[:enable_logical_deletes]
+    end
+    @config = configuration
+    #@config ||= configuration
+  end
+end # module RD3

data/lib/rd3/configuration.rb

@@ -0,0 +1,5 @@
+module RD3
+  class Configuration
+    attr_accessor :environment, :config_file_directory, :enable_logical_deletes
+  end
+end

data/lib/rd3/data_providers/azure_table_storage.rb

@@ -0,0 +1,67 @@
+require 'yaml'
+require 'waz-storage'
+require 'waz-tables'
+
+module RD3
+  module DataProviders
+    module AzureTableStorage
+      extend ActiveSupport::Concern
+
+      included do
+        def self.client
+          return @client if @client
+
+          yml_config = YAML.load(File.read("#{RD3.config.config_file_directory}/#{self.config_file_name}.yml"))[RD3.config.environment.to_s]
+          yml_config = yml_config.symbolize_keys
+
+          WAZ::Storage::Base.establish_connection!(:account_name => yml_config[:storage_account_name],
+                                                   :access_key => yml_config[:primary_access_key])
+          @client = WAZ::Tables::Table.service_instance
+        end
+
+        def self.save(attributes)
+          # convert the key attribute to partition key
+          # NOTE: don't overwrite the partion key if it has already been set
+          attributes[:partition_key] ||= partition_key = attributes.delete(:key)
+
+          unless attributes[:Timestamp]
+            self.client.insert_entity(self.table_name.to_s, attributes)
+          else
+            self.client.update_entity(self.table_name.to_s, attributes)
+          end
+
+          partition_key
+        end
+
+        def self.find_by_key(key, opts={})
+          begin
+            if db_instance = @client.get_entity(self.table_name.to_s, key, opts[:row_key])
+              db_instance unless self._logical_only(opts) && !db_instance[:active]
+            end
+          rescue RestClient::ResourceNotFound # returns nil
+          end
+        end
+
+        def self.delete(key, opts={})
+          if self._logical_only(opts)
+            attributes= {:partition_key => key,
+                         :row_key => opts[:row_key],
+                         :active => false}
+            @client.update_entity(self.table_name.to_s, attributes)
+          else
+            @client.delete_entity(self.table_name.to_s, key, opts[:row_key])
+          end
+        end
+
+        def self._logical_only(opts)
+          unless opts[:logical_only].nil?
+            opts[:logical_only]
+          else
+            RD3.config.enable_logical_deletes
+          end
+        end
+      end # included do
+
+    end # module AzureTableStorage
+  end # module DataProviders
+end # module RD3

data/lib/rd3/data_providers/rdbms.rb

@@ -0,0 +1,62 @@
+require 'yaml'
+require 'sequel'
+
+module RD3
+  module DataProviders
+    module Rdbms
+      extend ActiveSupport::Concern
+
+      included do
+        def self.client
+          return @client if @client
+
+          yml_config = YAML.load(File.read("#{RD3.config.config_file_directory}/#{self.config_file_name}.yml"))[RD3.config.environment.to_s]
+          yml_config = yml_config.symbolize_keys
+
+          @client = Sequel.connect(yml_config)
+        end
+
+        def self.save(attributes)
+          if id = attributes.delete(:id)
+            self._table.where('id = ?', id).update(attributes)
+          else
+            id = self._table.insert(attributes)
+          end
+
+          id
+        end
+
+        def self.find_by_key(key, opts={})
+          # logically deleted instances will return nil
+          # if the key exists, but the active flag is false
+          filter_logical_deletes = unless opts[:logical_only].nil?
+                                      opts[:logical_only]
+                                   else
+                                      RD3.config.enable_logical_deletes
+                                   end
+          filter = {:id => key}
+          filter.merge!(:active => filter_logical_deletes) if filter_logical_deletes
+          self._table.where(filter).first
+        end
+
+        def self.delete(id, opts)
+          logical_delete = unless opts[:logical_only].nil?
+                             opts[:logical_only]
+                           else
+                             RD3.config.enable_logical_deletes
+                           end
+          if logical_delete
+            self.save({:id => id, :active => false})
+          else
+            self._table.where('id = ?', id).delete
+          end
+        end
+
+        def self._table
+          self.client[self.table_name]
+        end
+      end
+
+    end
+  end
+end

data/lib/rd3/model.rb

@@ -0,0 +1,108 @@
+require 'active_support/core_ext' # necessary for Hash.to_json and Hash.as_json
+
+module RD3
+  module Model
+    extend ActiveSupport::Concern
+    include ActiveModel::Validations
+
+    included do
+       def self.class_attributes
+         @class_attributes
+       end
+
+       # NOTE: this method must be declared
+       #       before the attribute declarations
+       def self.attribute(*args)
+         @class_attributes ||= []
+         attributes_with_defaults = args.reduce({}) do |hash, arg|
+           arg.instance_of?(Hash) ? hash.merge(arg) : hash.merge(arg => nil)
+         end
+         @class_attributes.concat(attributes_with_defaults.keys)
+
+         attributes_with_defaults.each do |attribute, default|
+           getter = "@#{attribute}"
+           getter.prepend("@#{attribute} = #{default} if @#{attribute}.nil?;") unless default.nil?
+
+           self.module_eval <<-EVAL
+             def #{attribute}=(value)
+               # set dirty flag
+               @dirty = true unless @dirty || @#{attribute} == value
+               @#{attribute} = value
+             end
+             def #{attribute}
+              #{getter} 
+             end
+           EVAL
+         end
+       end
+
+       attribute :id, :created_at, :updated_at
+       attribute :active=>true
+    end
+
+    # NOTE: 1) we can create a new instance with a hash
+    #          in such a case, default values will be set
+    #       2) we can also create a new instance by COPYING
+    #          properties from one object to another via
+    #          its attributes
+    #          in such a case, default values will NOT be set
+    def initialize(*args)
+      # default to an empty hash if Class.new is called, i.e., args = nil
+      obj = args[0] || {}
+
+      # an instance SHOULD be marked as dirty if:
+      #   1) it's initialized w/ a non-empty hash
+      #
+      # it SHOULD NOT be marked as dirty if:
+      #   1) Class.new is called (empty hash)
+      #   2) we're mapping from one object to another
+      is_dirty = obj.instance_of?(Hash) && !obj.blank?
+
+      # grab attributes hash if we're dealing w/ mapping
+      # an object instance
+      obj = obj.attributes unless obj.instance_of? Hash
+
+      # map properties
+      obj.each do |k,v|
+        self.send("#{k}=", v) if self.class_attributes.include? k
+      end
+
+      # reset dirty flag
+      @dirty = is_dirty
+
+      # return self for method chaining
+      self
+    end
+
+    # tracks whether or not the instance
+    # has been updated/changed post initialization
+    def dirty?
+      return @dirty ||= false
+    end
+
+    def persisted?
+      id.present?
+    end
+
+    def class_attributes
+      return self.class.class_attributes
+    end
+
+    def attributes
+      self.instance_values.select { |key| class_attributes.include? key.to_sym }.symbolize_keys
+    end
+
+    # add errors to errors collection
+    # allows errors to bubble up from a child
+    # model to its parent model when working
+    # with repositories
+    def errors=(value)
+      unless value.blank?
+        value.each do |k, v|
+          self.errors[k] = v
+        end
+      end
+    end
+
+  end # module Model
+end  # module RD3