ardm 0.0.1

data/lib/ardm/support/subject_set.rb

@@ -0,0 +1,250 @@
+module Ardm
+
+  # An insertion ordered set of named objects
+  #
+  # {SubjectSet} uses {Ardm::OrderedSet}
+  # under the hood to keep track of a set of
+  # entries. In Ardm code, a subject
+  # can be either a {Ardm::Property}, or
+  # a {Ardm::Associations::Relationship}.
+  #
+  # All entries added to instances of this
+  # class must respond to the {#name} method
+  #
+  # The motivation behind this is that we
+  # use this class as a base to keep track
+  # properties and relationships.
+  # The following constraints apply for these
+  # types of objects: {Property} names must be
+  # unique within any model.
+  # {Associations::Relationship} names must be
+  # unique within any model
+  #
+  # When adding an entry with a name that
+  # already exists, the already existing
+  # entry will be replaced with the new
+  # entry with the same name. This is because
+  # we want to be able to update properties,
+  # and relationship during the course of
+  # initializing our application.
+  #
+  # This also happens to be consistent with
+  # the way ruby handles redefining methods,
+  # where the last definitions "wins".
+  #
+  # Furthermore, the builtin ruby {Set#<<} method
+  # also updates the old object if a new object
+  # gets added.
+  #
+  # @api private
+  class SubjectSet
+
+    # An {OrderedSet::Cache::API} implementation that establishes
+    # set semantics based on the name of its entries. The cache
+    # uses the entries' names as cache key and refuses to add
+    # entries that don't respond_to?(:name).
+    #
+    # @see OrderedSet::Cache::API
+    #
+    # @api private
+    class NameCache
+
+      include OrderedSet::Cache::API
+
+      # Tests if the given entry qualifies to be added to the cache
+      #
+      # @param [#name] entry
+      #   the entry to be checked
+      #
+      # @return [Boolean]
+      #   true if the entry respond_to?(:name)
+      #
+      # @api private
+      def valid?(entry)
+        entry.respond_to?(:name)
+      end
+
+      # Given an entry, return the key to be used in the cache
+      #
+      # @param [#name] entry
+      #   the entry to get the key for
+      #
+      # @return [#to_s, nil]
+      #   the entry's name or nil if the entry isn't #valid?
+      #
+      # @api private
+      def key_for(entry)
+        valid?(entry) ? entry.name : nil
+      end
+
+    end # class NameCache
+
+    include Enumerable
+
+    # The elements in the SubjectSet
+    #
+    # @return [OrderedSet]
+    #
+    # @api private
+    attr_reader :entries
+
+    # Initialize a SubjectSet
+    #
+    # @param [Enumerable<#name>] entries
+    #   the entries to initialize this set with
+    #
+    # @api private
+    def initialize(entries = [])
+      @entries = OrderedSet.new(entries, NameCache)
+    end
+
+    # Initialize a copy of a SubjectSet
+    #
+    # @api private
+    def initialize_copy(*)
+      @entries = @entries.dup
+    end
+
+    # Make sure that entry is part of this SubjectSet
+    #
+    # If an entry with the same name already exists, it
+    # will be updated. If no such named entry exists, it
+    # will be added.
+    #
+    # @param [#name] entry
+    #   the entry to be added
+    #
+    # @return [SubjectSet] self
+    #
+    # @api private
+    def <<(entry)
+      entries << entry
+      self
+    end
+
+    # Delete an entry from this SubjectSet
+    #
+    # @param [#name] entry
+    #   the entry to delete
+    #
+    # @return [#name, nil]
+    #   the deleted entry or nil
+    #
+    # @api private
+    def delete(entry)
+      entries.delete(entry)
+    end
+
+    # Removes all entries and returns self
+    #
+    # @return [SubjectSet] self
+    #
+    # @api private
+    def clear
+      entries.clear
+      self
+    end
+
+    # Test if the given entry is included in this SubjectSet
+    #
+    # @param [#name] entry
+    #   the entry to test for
+    #
+    # @return [Boolean]
+    #   true if the entry is included in this SubjectSet
+    #
+    # @api private
+    def include?(entry)
+      entries.include?(entry)
+    end
+
+    # Tests wether the SubjectSet contains a entry named name
+    #
+    # @param [#to_s] name
+    #   the entry name to test for
+    #
+    # @return [Boolean]
+    #   true if the SubjectSet contains a entry named name
+    #
+    # @api private
+    def named?(name)
+      !self[name].nil?
+    end
+
+    # Check if there are any entries
+    #
+    # @return [Boolean]
+    #   true if the set contains at least one entry
+    #
+    # @api private
+    def empty?
+      entries.empty?
+    end
+
+    # Lookup an entry in the SubjectSet based on a given name
+    #
+    # @param [#to_s] name
+    #   the name of the entry
+    #
+    # @return [Object, nil]
+    #   the entry having the given name, or nil if not found
+    #
+    # @api private
+    def [](name)
+      name = name.to_s
+      entries.detect { |entry| entry.name.to_s == name }
+    end
+
+    # Iterate over each entry in the set
+    #
+    # @yield [entry]
+    #   each entry in the set
+    #
+    # @yieldparam [#name] entry
+    #   an entry in the set
+    #
+    # @return [SubjectSet] self
+    #
+    # @api private
+    def each
+      entries.each { |entry| yield(entry) }
+      self
+    end
+
+    # All entries (or nil values) that have any of the given names
+    #
+    # @param [Enumerable<#to_s>] names
+    #   the names of the desired entries
+    #
+    # @return [Array<#name, nil>]
+    #   an array containing entries whose names match any of the given
+    #   names, or nil values for those names with no matching entries
+    #   in the set
+    #
+    # @api private
+    def values_at(*names)
+      names.map { |name| self[name] }
+    end
+
+    # Get the number of elements inside this SubjectSet
+    #
+    # @return [Integer]
+    #   the number of elements
+    #
+    # @api private
+    def size
+      entries.size
+    end
+
+    # Convert the SubjectSet into an Array
+    #
+    # @return [Array]
+    #   an array containing all the SubjectSet's entries
+    #
+    # @api private
+    def to_ary
+      to_a
+    end
+
+  end # class SubjectSet
+end # module Ardm

data/lib/ardm/version.rb

@@ -0,0 +1,3 @@
+module Ardm
+  VERSION = '0.0.1'
+end

data/lib/ardm.rb

@@ -0,0 +1,56 @@
+puts __FILE__
+module Ardm
+  # Check which ORM is loaded in Ardm.
+  #
+  # @api public
+  def self.orm
+    @orm ||= :active_record
+  end
+
+  # Set which orm to load.
+  #
+  # @api public
+  def self.orm=(orm)
+    if defined?(Ardm::ActiveRecord) || defined?(Ardm::DataMapper)
+      raise "Cannot change Ardm.orm when #{orm} libs are already loaded."
+    end
+
+    @orm = case orm.to_s
+           when /active_?record/, '' then :active_record
+           when /data_?mapper/       then :data_mapper
+           else raise "Unknown ENV['ORM']: #{ENV['ORM']}"
+           end
+  end
+
+  # Return true if Ardm has loaded ActiveRecord ORM.
+  #
+  # @api public
+  def self.active_record?
+    orm == :active_record
+  end
+
+  # Return true if Ardm has loaded DataMapper ORM.
+  #
+  # @api public
+  def self.data_mapper?
+    orm == :data_mapper
+  end
+
+  # Yield if Ardm has loaded ActiveRecord ORM.
+  #
+  # @api public
+  def self.active_record
+    yield if block_given? && active_record?
+  end
+
+  # Yield if Ardm has loaded DataMapper ORM.
+  #
+  # @api public
+  def self.data_mapper
+    yield if block_given? && data_mapper?
+  end
+
+  def self.lib
+    "ardm/#{orm}"
+  end
+end

data/spec/fixtures/api_user.rb

@@ -0,0 +1,11 @@
+module Ardm
+  module Fixtures
+    class APIUser < Ardm::Record
+      self.table_name = "api_users"
+
+      property :id, Serial
+      property :name, String
+      property :api_key, APIKey
+    end
+  end
+end

data/spec/fixtures/article.rb

@@ -0,0 +1,22 @@
+module Ardm
+  module Fixtures
+    class Article < Ardm::Record
+      self.table_name = "articles"
+
+      property :id,         Serial
+
+      property :title,      String, :length => 255
+      property :body,       Text
+
+      property :created_at,   DateTime
+      property :updated_at,   DateTime
+      property :published_at, DateTime
+
+      property :slug, Slug
+
+      before_validation do
+        self.slug = self.title
+      end
+    end # Article
+  end
+end

data/spec/fixtures/bookmark.rb

@@ -0,0 +1,14 @@
+module Ardm
+  module Fixtures
+    class Bookmark < Ardm::Record
+      self.table_name = "bookmarks"
+
+      property :id, Serial
+
+      property :title,  String, :length => 255
+      property :shared, Boolean
+      property :uri,    URI
+      property :tags,   Yaml
+    end # Bookmark
+  end
+end

data/spec/fixtures/invention.rb

@@ -0,0 +1,5 @@
+module Ardm
+  module Fixtures
+    Invention = Struct.new(:name)
+  end
+end

data/spec/fixtures/network_node.rb

@@ -0,0 +1,23 @@
+module Ardm
+  module Fixtures
+    class NetworkNode < Ardm::Record
+      self.table_name = "network_nodes"
+
+      property :id,               Serial
+      property :ip_address,       IPAddress
+      property :cidr_subnet_bits, Integer
+      property :node_uuid,        UUID
+
+      alias_method :uuid,  :node_uuid
+      alias_method :uuid=, :node_uuid=
+
+      def runs_ipv6?
+        self.ip_address.ipv6?
+      end
+
+      def runs_ipv4?
+        self.ip_address.ipv4?
+      end
+    end # NetworkNode
+  end # Fixtures
+end # Ardm

data/spec/fixtures/person.rb

@@ -0,0 +1,17 @@
+module Ardm
+  module Fixtures
+    class Person < Ardm::Record
+      self.table_name = "people"
+
+      property :id,         Serial
+      property :name,       String
+      property :positions,  Json
+      property :inventions, Yaml
+      property :birthday,   EpochTime
+
+      property :interests, CommaSeparatedList
+
+      property :password, BCryptHash
+    end
+  end
+end

data/spec/fixtures/software_package.rb

@@ -0,0 +1,22 @@
+module Ardm
+  module Fixtures
+    class SoftwarePackage < ::Ardm::Record
+      self.table_name = "software_packages"
+
+      property :id, Serial
+      property :node_number, Integer, :index => true
+
+      property :source_path,      FilePath
+      property :destination_path, FilePath
+
+      property :product,     String
+      property :version,     String
+      property :released_at, DateTime
+
+      property :security_update,  Boolean
+
+      property :installed_at,     DateTime
+      property :installed_by,     String
+    end # SoftwarePackage
+  end # Fixtures
+end # Ardm

data/spec/fixtures/ticket.rb

@@ -0,0 +1,12 @@
+module Ardm
+  module Fixtures
+    class Ticket < ::Ardm::Record
+      self.table_name = "tickets"
+
+      property :id,     Serial
+      property :title,  String, :length => 255
+      property :body,   Text
+      property :status, Enum[:unconfirmed, :confirmed, :assigned, :resolved, :not_applicable]
+    end # Ticket
+  end
+end

data/spec/fixtures/tshirt.rb

@@ -0,0 +1,15 @@
+module Ardm
+  module Fixtures
+      class TShirt < ::Ardm::Record
+        self.table_name = "tshirts"
+
+        property :id,          Serial
+        property :writing,     String
+        property :has_picture, Boolean, :default => false, :required => true
+        property :picture,     Enum[:octocat, :fork_you, :git_down]
+
+        property :color, Enum[:white, :black, :red, :orange, :yellow, :green, :cyan, :blue, :purple]
+        property :size,  Flag[:xs, :small, :medium, :large, :xl, :xxl], :default => :xs
+      end # Shirt
+    end # Fixtures
+end # Ardm

data/spec/integration/api_key_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+try_spec do
+  require './spec/fixtures/api_user'
+
+  describe Ardm::Fixtures::APIUser do
+    subject { described_class.new(:name => 'alice') }
+
+    let(:original_api_key) { subject.api_key }
+
+    it "should have a default value" do
+      original_api_key.should_not be_nil
+    end
+
+    it "should preserve the default value" do
+      subject.api_key.should == original_api_key
+    end
+
+    it "should generate unique API Keys for each resource" do
+      other_resource = described_class.new(:name => 'eve')
+
+      other_resource.api_key.should_not == original_api_key
+    end
+  end
+end

data/spec/integration/bcrypt_hash_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+try_spec do
+
+  require './spec/fixtures/person'
+
+  describe Ardm::Fixtures::Person do
+    before do
+      @resource  = Ardm::Fixtures::Person.create!(:password => 'Ardm R0cks!')
+      Ardm::Fixtures::Person.create!(:password => 'password1')
+
+      @people = Ardm::Fixtures::Person.all
+      @resource.reload
+    end
+
+    it 'persists the password on initial save' do
+      @resource.password.should       == 'Ardm R0cks!'
+      @people.last.password.should == 'password1'
+    end
+
+    it 'recalculates password hash on attribute update' do
+      @resource.attribute_set(:password, 'bcryptic obscure')
+      @resource.save
+
+      @resource.reload
+      @resource.password.should     == 'bcryptic obscure'
+      @resource.password.should_not == 'Ardm R0cks!'
+    end
+
+    it 'does not change password value on reload' do
+      resource = @people.last
+      original = resource.password.to_s
+      resource.reload
+      resource.password.to_s.should == original
+    end
+
+    it 'uses cost of BCrypt::Engine::DEFAULT_COST' do
+      @resource.password.cost.should == BCrypt::Engine::DEFAULT_COST
+    end
+
+    it 'allows Bcrypt::Password#hash to be an Integer' do
+      @resource.password.hash.should be_kind_of(Integer)
+    end
+  end
+end

data/spec/integration/comma_separated_list_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+try_spec do
+
+  require './spec/fixtures/person'
+
+  describe Ardm::Fixtures::Person do
+    before do
+      @resource = Ardm::Fixtures::Person.new(:name => '')
+    end
+
+    describe 'with no interests information' do
+      before do
+        @resource.interests = nil
+      end
+
+      describe 'when dumped and loaded again' do
+        before do
+          @resource.save.should be_true
+          @resource.reload
+        end
+
+        it 'has no interests' do
+          @resource.interests.should == nil
+        end
+      end
+    end
+
+    describe 'with no interests information' do
+      before do
+        @resource.interests = []
+      end
+
+      describe 'when dumped and loaded again' do
+        before do
+          @resource.save.should be_true
+          @resource.reload
+        end
+
+        it 'has empty interests list' do
+          @resource.interests.should == []
+        end
+      end
+    end
+
+    describe 'with interests information given as a Hash' do
+      it 'raises ArgumentError' do
+        lambda do
+          @resource.interests = { :hash => 'value' }
+          @resource.save
+        end.should raise_error(ArgumentError, /must be a string, an array or nil/)
+      end
+    end
+
+    describe 'with a few items on the interests list' do
+      before do
+        @input = 'fire, water, fire, a whole lot of other interesting things, ,,,'
+        @resource.interests = @input
+      end
+
+      describe 'when dumped and loaded again' do
+        before do
+          @resource.save.should be_true
+          @resource.reload
+        end
+
+        it 'includes "fire" in interests' do
+          @resource.interests.should include('fire')
+        end
+
+        it 'includes "water" in interests' do
+          @resource.interests.should include('water')
+        end
+
+        it 'includes "a whole lot of other interesting things" in interests' do
+          @resource.interests.should include('a whole lot of other interesting things')
+        end
+
+        it 'has blank entries removed' do
+          @resource.interests.any? { |i| Ardm::Ext.blank?(i) }.should be_false
+        end
+      end
+    end
+  end
+end