delineate 0.6.0

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+#require 'bundler/setup'
+#Bundler.require
+
+#require 'simplecov'
+#SimpleCov.start
+
+ENV['RAILS_ENV'] = 'test'
+
+require 'active_support'
+require 'active_support/core_ext/logger'
+require 'active_record'
+
+require 'rspec'
+
+require 'delineate'
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+#Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end
+
+# a little sugar for checking results of a section of code
+alias :running :lambda
+
+
+# Set the DB var if testing with other than sqlite
+ENV['DB'] ||= 'sqlite3'
+
+database_yml = File.expand_path('../database.yml', __FILE__)
+if File.exists?(database_yml)
+  active_record_configuration = YAML.load_file(database_yml)[ENV['DB']]
+
+  ActiveRecord::Base.establish_connection(active_record_configuration)
+  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "test.log"))
+  #ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+  ActiveRecord::Base.silence do
+    ActiveRecord::Migration.verbose = false
+
+    load(File.dirname(__FILE__) + '/support/schema.rb')
+    create_schema!
+
+    load(File.dirname(__FILE__) + '/support/models.rb')
+    clean_database!
+  end
+else
+  raise "Create #{database_yml} first to configure your database. Take a look at: #{database_yml}.sample"
+end

data/spec/support/models.rb

@@ -0,0 +1,184 @@
+# Contains ActiveRecord model test classes
+
+class Post < ActiveRecord::Base
+end
+class Author < ActiveRecord::Base
+end
+#class Comment < ActiveRecord::Base
+#end
+#class Reply < Comment
+#end
+class Topic < ActiveRecord::Base
+end
+class AuthorGroup < ActiveRecord::Base
+end
+class Email < ActiveRecord::Base
+end
+
+class PostTopic < ActiveRecord::Base
+  belongs_to  :post
+  belongs_to  :topic
+  has_one     :author, :through => :post
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to  :post
+  accepts_nested_attributes_for :post
+
+  attr_accessible :commentor, :content, :post, :post_attributes, :post_id
+
+  map_attributes :api do
+    attribute :id
+    attribute :commentor
+    attribute :content
+    attribute :created_at, :access => :ro
+
+    association :post, :optional => true
+  end
+end
+
+class Reply < Comment
+  attr_accessible :type
+
+  map_attributes :api do
+    attribute :type
+  end
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :author
+  has_many   :post_topics
+  has_many   :topics, :through => :post_topics
+  has_many   :comments
+
+  accepts_nested_attributes_for :author, :allow_destroy => true
+  accepts_nested_attributes_for :post_topics
+  accepts_nested_attributes_for :topics, :allow_destroy => false
+  accepts_nested_attributes_for :comments, :allow_destroy => true
+
+  attr_accessible :title, :content, :author, :author_attributes, :post_topics, :post_topics_attributes, :comments, :comments_attributes
+  attr_accessible :topics, :topics_attributes
+
+  map_attributes :api do
+    attribute :id
+    attribute :title
+    attribute :content
+    attribute :created_at, :access => :ro
+
+    attribute :heavy_attr, :access => :ro, :optional => :extended_attrs
+
+    association :author, :override => :merge do
+      attribute :name, :using => :full_name, :access => :ro
+    end
+
+    association :topics
+    association :comments, :optional => true, :polymorphic => true
+  end
+
+  def heavy_attr
+    true
+  end
+end
+
+class Author < ActiveRecord::Base
+  belongs_to  :author_group
+  has_many    :posts
+  has_many    :post_topics, :through => :posts
+  has_one     :email
+
+  accepts_nested_attributes_for :author_group
+  accepts_nested_attributes_for :posts
+  accepts_nested_attributes_for :email, :allow_destroy => true
+
+  attr_accessible :first_name, :last_name, :full_name, :email_attributes, :posts_attributes, :author_group, :author_group_attributes
+
+  scope :by_topic, lambda {|topic_id| joins(:post_topics).where(:topic_id => topic_id)}
+
+  map_attributes :api do
+    attribute :id
+    attribute :first_name
+    attribute :last_name
+
+    association :email, :polymorphic => true
+    association :posts, :optional => true, :override => :replace do
+      attribute :id
+      attribute :title
+      attribute :content
+      attribute :created_at, :access => :ro
+    end
+    #association :posts_circular, :using => :posts, :optional => true  # This should generate "circular merge" error when included
+    association :author_group, :optional => true
+  end
+
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+
+  def topics
+    post_topics.map{|pt| pt.topic.name}.uniq
+  end
+end
+
+class Email < ActiveRecord::Base
+  belongs_to  :author
+
+  attr_accessible :email_addr, :author_id
+
+  map_attributes :api do
+    attribute :id
+    attribute :email, :using => :email_addr
+  end
+end
+
+class SpecialEmail < Email
+  attr_accessible :special_email
+
+  map_attributes :api do
+    attribute :special_email
+  end
+
+  def special_email
+    'special'
+  end
+end
+
+
+class Topic < ActiveRecord::Base
+  has_many :post_topics
+  has_many :posts, :through => :post_topics
+
+  attr_accessible :name
+
+  map_attributes :api do
+    attribute :id
+    attribute :topic, :using => :name
+  end
+end
+
+class AuthorGroup < ActiveRecord::Base
+  has_many  :authors
+
+  accepts_nested_attributes_for :authors
+  attr_accessible :name, :authors_attributes
+
+  map_attributes :api do
+    attribute   :id
+    attribute   :name
+    association :authors, :optional => true
+  end
+end
+
+
+
+# Used to reinitialize class defintions
+def reload_model_classes!
+  Object.send(:remove_const, :Post)
+  Object.send(:remove_const, :Author)
+  Object.send(:remove_const, :Reply)
+  Object.send(:remove_const, :Comment)
+  Object.send(:remove_const, :Topic)
+  Object.send(:remove_const, :AuthorGroup)
+  Object.send(:remove_const, :PostTopic)
+
+  load __FILE__
+end

data/spec/support/schema.rb

@@ -0,0 +1,125 @@
+# Support for creating the test schema and seed data
+
+def create_schema!
+  ActiveRecord::Schema.define :version => 0 do
+    create_table "posts", :force => true do |t|
+      t.string      :title
+      t.text        :content
+      t.references  :author, :null => :false
+      t.datetime    :created_at
+    end
+
+    create_table "authors", :force => true do |t|
+      t.string    :first_name
+      t.string    :last_name
+      t.references :author_group
+    end
+
+    create_table "comments", :force => true do |t|
+      t.string      :commentor
+      t.references  :post
+      t.text        :content
+      t.string      :type
+      t.datetime    :created_at
+    end
+
+    create_table "topics", :force => true do |t|
+      t.string :name
+    end
+
+    create_table "post_topics", :force => true do |t|
+      t.references :topic
+      t.references :post
+    end
+
+    create_table "author_groups", :force => true do |t|
+      t.string  :name
+    end
+
+    create_table "emails", :force => true do |t|
+      t.string      :email_addr
+      t.references  :author
+      t.string      :type
+    end
+
+  end
+end
+
+def clean_database!
+  seed_author_groups
+  seed_authors
+  seed_emails
+  seed_topics
+  seed_posts
+  seed_post_topics
+  seed_comments
+end
+
+def seed_author_groups
+  ActiveRecord::Base.connection.execute "DELETE FROM author_groups"
+  AuthorGroup.create!(:name => 'Admin')   # 1
+  AuthorGroup.create!(:name => 'Staff')   # 2
+  AuthorGroup.create!(:name => 'Guest')   # 3
+end
+
+def seed_authors
+  ActiveRecord::Base.connection.execute "DELETE FROM authors"
+  Author.create!(:first_name => 'Tom', :last_name => 'Smith', :author_group => AuthorGroup.find_by_name('Admin'))
+  Author.create!(:first_name => 'John', :last_name => 'Staffer', :author_group => AuthorGroup.find_by_name('Staff'))
+  Author.create!(:first_name => 'John', :last_name => 'Smith', :author_group => AuthorGroup.find_by_name('Staff'))
+  Author.create!(:first_name => 'John', :last_name => 'Public', :author_group => AuthorGroup.find_by_name('Guest'))
+  Author.create!(:first_name => 'Mary', :last_name => 'Jones', :author_group => AuthorGroup.find_by_name('Staff'))
+  Author.create!(:first_name => 'Julie', :last_name => 'Smith', :author_group => AuthorGroup.find_by_name('Guest'))
+end
+
+def seed_emails
+  Email.create!(:author_id => 1, :email_addr => 'author1@email.com')
+  Email.create!(:author_id => 2, :email_addr => 'author2@email.com')
+  Email.create!(:author_id => 3, :email_addr => 'author3@email.com')
+  Email.create!(:author_id => 4, :email_addr => 'author4@email.com')
+  SpecialEmail.create!(:author_id => 5, :email_addr => 'author5@email.com')
+end
+
+def seed_topics
+  ActiveRecord::Base.connection.execute "DELETE FROM topics"
+  Topic.create!(:name => 'NoSQL')       # 1
+  Topic.create!(:name => 'Ruby')        # 2
+  Topic.create!(:name => 'Rails')       # 3
+  Topic.create!(:name => 'Events')      # 4
+  Topic.create!(:name => 'General')     # 5
+end
+
+def seed_posts
+  Post.create!(:title => "Post Number 1" , :content => "This is the content for post 1" , :author => Author.find(1))
+  Post.create!(:title => "Post Number 2" , :content => "This is the content for post 2" , :author => Author.find(2))
+  Post.create!(:title => "Post Number 3" , :content => "This is the content for post 3" , :author => Author.find(3))
+  Post.create!(:title => "Post Number 4" , :content => "This is the content for post 4" , :author => Author.find(4))
+  Post.create!(:title => "Post Number 5" , :content => "This is the content for post 5" , :author => Author.find(5))
+
+  Post.create!(:title => "Post Number 6" , :content => "This is the content for post 6" , :author => Author.find(1))
+  Post.create!(:title => "Post Number 7" , :content => "This is the content for post 7" , :author => Author.find(1))
+end
+
+def seed_post_topics
+  PostTopic.create!(:topic => Topic.find_by_name('NoSQL'), :post_id => 1)
+  PostTopic.create!(:topic => Topic.find_by_name('Events'), :post_id => 1)
+
+  PostTopic.create!(:topic => Topic.find_by_name('NoSQL'), :post_id => 2)
+  PostTopic.create!(:topic => Topic.find_by_name('Ruby'), :post_id => 3)
+  PostTopic.create!(:topic => Topic.find_by_name('Rails'), :post_id => 4)
+  PostTopic.create!(:topic => Topic.find_by_name('Events'), :post_id => 5)
+  PostTopic.create!(:topic => Topic.find_by_name('General'), :post_id => 6)
+  PostTopic.create!(:topic => Topic.find_by_name('Ruby'), :post_id => 7)
+  PostTopic.create!(:topic => Topic.find_by_name('Rails'), :post_id => 7)
+end
+
+def seed_comments
+  Comment.create!(:commentor => 'Anonymous', :post_id => 1, :content => 'Comment 1 for post 1')
+  Comment.create!(:commentor => 'commentor1', :post_id => 1, :content => 'Comment 2 for post 1')
+  Comment.create!(:commentor => 'commentor2', :post_id => 2, :content => 'Comment 1 for post 2')
+  Comment.create!(:commentor => 'commentor3', :post_id => 3, :content => 'Comment 1 for post 3')
+  Comment.create!(:commentor => 'commentor7', :post_id => 7, :content => 'Comment 1 for post 7')
+  Comment.create!(:commentor => 'commentor8', :post_id => 7, :content => 'Comment 2 for post 7')
+
+  Reply.create!(:commentor => 'commentor1', :post_id => 1, :content => 'Reply to Comment for post 1')
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: delineate
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Tom Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  prerelease: false
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  prerelease: false
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  prerelease: false
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  prerelease: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  prerelease: false
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  prerelease: false
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+description: ActiveRecord serializer DSL for mapping model attributes and associations.
+  Similar to  ActiveModel Serializers with many enhancements including bi-directional
+  support, i.e. deserialization.
+email: tsmith@landfall.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- delineate.gemspec
+- lib/class_inheritable_attributes.rb
+- lib/core_extensions.rb
+- lib/delineate.rb
+- lib/delineate/attribute_map/attribute_map.rb
+- lib/delineate/attribute_map/csv_serializer.rb
+- lib/delineate/attribute_map/json_serializer.rb
+- lib/delineate/attribute_map/map_serializer.rb
+- lib/delineate/attribute_map/xml_serializer.rb
+- lib/delineate/map_attributes.rb
+- spec/database.yml
+- spec/delineate_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: http://github.com/rtomsmith/delineate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord serializer DSL for mapping model attributes and associations
+test_files: []