mark_mapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8da86f713512ffdee54852951d9e1e2f94c0bf5
+  data.tar.gz: 768ad651bee67d55396095b14db35963387fa9bc
+SHA512:
+  metadata.gz: b78ac1946be9798b7b53f6299d2164cafd6b941b603584b1aa5ce720ce9139ffe85c5ca7ee00a30b41c00d292b4327b44f01e504ceb9f4c2b383e787446a1715
+  data.tar.gz: 5dfb0ecac9c51de0b446d7466d56e7baedd97fe84f79102126aa21b6938fc194dc3c11fed2023a78749672abc3b473ee5a61750b20f30f037c929874948b084f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Paxton Hare
+
+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.rdoc

@@ -0,0 +1,39 @@
+= MarkMapper
+
+A Ruby Object Mapper for MarkLogic.
+
+== Install
+
+    $ gem install mark_mapper
+
+== Documentation
+
+http://markmapper.com/documentation/
+
+http://rdoc.info/github/markmapper/markmapper
+
+== Compatibility
+
+MarkMapper is tested against:
+
+* MRI 2.2.0
+
+Additionally, MarkMapper is tested against:
+
+* Rails 4.2.x
+
+== Contributing & Development
+
+    $ git clone https://github.com/paxtonhare/markmapper && cd markmapper
+    $ bundle install
+    $ bundle exec rake
+
+* Fork the project.
+* Make your feature addition or bug fix. All specs should pass.
+* Add specs for your changes. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history. If you want to have your own version, that is fine but bump version in a commit by itself in another branch so a maintainer ignore it when your pull request is merged.
+* Send a pull request. Bonus points for topic branches.
+
+== License & Copyright
+
+See LICENSE for details.

data/examples/attr_accessible.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require_relative './sample_app'
+
+MarkMapper.application.create
+
+class User
+  include MarkMapper::Document
+  key :email, String
+  key :admin, Boolean, :default => false
+
+  # Only accessible or protected can be used, they cannot be used together
+  attr_accessible :email
+end
+
+# only accessible are set on new/create/etc.
+user = User.create(:email => 'IDontLowerCaseThings@gmail.com', :admin => true)
+puts user.admin # false
+
+# can be set using accessor
+user.admin = true
+user.save
+puts user.admin # true
+
+MarkMapper.application.drop

data/examples/attr_protected.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require_relative './sample_app'
+
+MarkMapper.application.create
+
+class User
+  include MarkMapper::Document
+  key :email, String
+  key :admin, Boolean, :default => false
+
+  # Only accessible or protected can be used, they cannot be used together
+  attr_protected :admin
+end
+
+# protected are ignored on new/create/etc.
+user = User.create(:email => 'IDontLowerCaseThings@gmail.com', :admin => true)
+puts user.admin # false
+
+# can be set using accessor
+user.admin = true
+user.save
+puts user.admin # true
+
+MarkMapper.application.drop

data/examples/cache_key.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require_relative './sample_app'
+
+MarkMapper.application.create
+
+class User
+  include MarkMapper::Document
+end
+
+# New Documents
+puts User.new.cache_key     # User/new
+
+# Created Documents
+puts User.create.cache_key  # User/:id (ie: User/4c7a940cbcd1b3319b000003)
+
+# With Suffix
+puts User.create.cache_key(:foo) # User/:id/foo
+
+# With Multiple Suffixes
+puts User.create.cache_key(:foo, :bar, :baz) # User/:id/foo/bar/baz
+
+# When updated_at key exists it will be used
+User.timestamps!
+puts User.create.cache_key  # User/:id-:updated_at (ie: User/4c7a940cbcd1b3319b000003-20100829170828)
+
+MarkMapper.application.drop

data/examples/custom_types.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require_relative './sample_app'
+require 'pp'
+
+MarkMapper.application.create
+
+class DowncasedString
+  # to_marklogic gets called anytime a value is assigned
+  def self.to_marklogic(value)
+    value.nil? ? nil : value.to_s.downcase
+  end
+
+  # from marklogic gets called anytime a value is read
+  def self.from_marklogic(value)
+    value.nil? ? nil : value.to_s.downcase
+  end
+end
+
+class User
+  include MarkMapper::Document
+  key :email, DowncasedString
+end
+
+pp User.create(:email => 'IDontLowerCaseThings@gmail.com')
+
+MarkMapper.application.drop

data/examples/identity_map.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require_relative './sample_app'
+require 'pp'
+
+MarkMapper.application.create
+
+MarkMapper::Plugins::IdentityMap.enabled = true
+
+class User
+  include MarkMapper::Document
+
+  key :name, String
+end
+User.delete_all
+
+# User gets added to map on save
+user = User.create(:name => 'John')
+
+# Does not matter how you find user, it is always the same object until the identity map is cleared
+puts "#{User.find(user.id).object_id} == #{user.object_id}"
+puts "#{User.all[0].object_id} == #{user.object_id}"
+
+MarkMapper::Plugins::IdentityMap.clear
+puts "#{User.find(user.id).object_id} != #{user.object_id}"
+
+# User gets removed from map on destroy
+user = User.create
+user.destroy
+
+MarkMapper.application.drop

data/examples/identity_map/automatic.rb

@@ -0,0 +1,2 @@
+# Using the following will turn on identity map for all models
+MarkMapper::Plugins::IdentityMap.enabled = true

data/examples/keys.rb

@@ -0,0 +1,42 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require_relative './sample_app'
+require 'pp'
+
+MarkMapper.application.create
+
+class User
+  include MarkMapper::Document
+
+  key :first_name,  String, :required => true
+  key :last_name,   String, :required => true
+  key :token,       String, :default => lambda { 'some random string' }
+  key :age,         Integer
+  key :skills,      Array
+  key :friend_ids,  Array, :typecast => 'ObjectId'
+  key :links,       Hash
+  timestamps!
+end
+User.collection.remove # empties collection
+
+john = User.create({
+  :first_name => 'John',
+  :last_name  => 'Nunemaker',
+  :age        => 28,
+  :skills     => ['ruby', 'marklogic', 'javascript'],
+  :links      => {"Google" => "http://www.google.com"}
+})
+
+steve = User.create({
+  :first_name => 'Steve',
+  :last_name  => 'Smith',
+  :age        => 29,
+  :skills     => ['html', 'css', 'javascript', 'design'],
+})
+
+john.friend_ids << steve.id.to_s # will get typecast to ObjectId
+john.links["Ruby on Rails"] = "http://www.rubyonrails.com"
+john.save
+
+pp john
+
+MarkMapper.application.drop

data/examples/modifiers/set.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.expand_path('../../../lib', __FILE__))
+require_relative '../sample_app'
+require 'pp'
+
+MarkMapper.application.create
+
+class User
+  include MarkMapper::Document
+
+  key :name, String
+  key :tags, Array
+end
+User.collection.remove # empties collection
+
+john = User.create(:name => 'John',  :tags => %w[ruby marklogic], :age => 28)
+bill = User.create(:name => 'Bill',  :tags => %w[ruby marklogic], :age => 30)
+
+User.set({:name => 'John'}, :tags => %[ruby])
+pp john.reload
+
+User.set(john.id, :tags => %w[ruby marklogic])
+pp john.reload
+
+john.set(:tags => %w[something different])
+pp john.reload
+
+MarkMapper.application.drop

data/examples/plugins.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require_relative './sample_app'
+require 'pp'
+
+MarkMapper.application.create
+
+# To create your own plugin, just create a module that
+# extends ActiveSupport::Concern.
+module FooPlugin
+  extend ActiveSupport::Concern
+
+  # ClassMethods module will automatically get extended
+  module ClassMethods
+    def foo
+      'Foo class method!'
+    end
+  end
+
+  def foo
+    'Foo instance method!'
+  end
+
+  # Any configuration can be done in the #included block, which gets
+  # class evaled. Feel free to add keys, validations, or anything else.
+  included do
+    puts "Configuring #{self}..."
+    key :foo, String
+  end
+end
+
+class User
+  include MarkMapper::Document
+  plugin FooPlugin
+end
+
+puts User.foo
+puts User.new.foo
+puts User.key?(:foo)
+
+MarkMapper.application.drop

data/examples/querying.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require_relative './sample_app'
+require 'pp'
+
+MarkMapper.application.tap do |app|
+  app.add_index(MarkLogic::DatabaseSettings::RangeElementIndex.new(:age, :type => 'int'))
+end.sync
+
+class User
+  include MarkMapper::Document
+
+  key :name, String
+  key :tags, Array
+end
+User.collection.remove # empties collection
+
+User.create(:name => 'John',  :tags => %w[ruby marklogic], :age => 28)
+User.create(:name => 'Bill',  :tags => %w[ruby marklogic], :age => 30)
+User.create(:name => 'Frank', :tags => %w[marklogic],      :age => 35)
+User.create(:name => 'Steve', :tags => %w[html5 css3], :age => 27)
+
+[
+
+  User.all(:name => 'John'),
+  User.all(:tags => %w[marklogic]),
+  # User.all(:tags.all => %w[ruby marklogic]),
+  User.all(:age.ge => 30),
+
+  User.where(:age.gt => 27).sort(:age).all,
+  User.where(:age.gt => 27).sort(:age.desc).all,
+  User.where(:age.gt => 27).sort(:age).limit(1).all,
+  User.where(:age.gt => 27).sort(:age).skip(1).limit(1).all,
+
+].each do |result|
+  pp result
+  puts
+end
+
+MarkMapper.application.drop

data/examples/sample_app.rb

@@ -0,0 +1,43 @@
+require 'marklogic'
+require 'mark_mapper'
+
+# These environment variables can be set if wanting to test against a database
+# that is not on the local machine.
+ENV["MARKMAPPER_SPEC_HOST"] ||= "localhost"
+ENV["MARKMAPPER_SPEC_PORT"] ||= "8009"
+
+ENV["MARKMAPPER_SPEC_APP_SERVICES_PORT"] ||= "8000"
+ENV["MARKMAPPER_SPEC_ADMIN_PORT"] ||= "8001"
+ENV["MARKMAPPER_SPEC_MANAGE_PORT"] ||= "8002"
+
+ENV["MARKMAPPER_SPEC_USER"] ||= "admin"
+ENV["MARKMAPPER_SPEC_PASSWORD"] ||= "admin"
+ENV["MARKMAPPER_SKIP_APP_CREATION"] ||= "false"
+
+# These are used when creating any connection in the test suite.
+HOST = ENV["MARKMAPPER_SPEC_HOST"]
+PORT = ENV["MARKMAPPER_SPEC_PORT"].to_i
+
+APP_SERVICES_PORT = ENV["MARKMAPPER_SPEC_APP_SERVICES_PORT"]
+MANAGE_PORT = ENV["MARKMAPPER_SPEC_MANAGE_PORT"]
+ADMIN_PORT = ENV["MARKMAPPER_SPEC_ADMIN_PORT"]
+
+USER = ENV["MARKMAPPER_SPEC_USER"]
+PASSWORD = ENV["MARKMAPPER_SPEC_PASSWORD"]
+
+ADMIN_USER = ENV["MARKMAPPER_SPEC_ADMIN_USER"]
+ADMIN_PASSWORD = ENV["MARKMAPPER_SPEC_ADMIN_PASSWORD"]
+
+MarkLogic::Connection.configure({
+  :host => HOST,
+  :manage_port => MANAGE_PORT,
+  :admin_port => ADMIN_PORT,
+  :app_services_port => APP_SERVICES_PORT,
+  :default_user => ADMIN_USER,
+  :default_password => ADMIN_PASSWORD
+})
+
+CONNECTION = MarkLogic::Connection.new(HOST, PORT)
+
+puts "Configuring application again"
+MarkMapper.application = MarkLogic::Application.new("sample-app", connection: CONNECTION )

data/examples/scopes.rb

@@ -0,0 +1,56 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require_relative './sample_app'
+require 'pp'
+
+MarkMapper.application.tap do |app|
+  app.add_index(MarkLogic::DatabaseSettings::RangeElementIndex.new(:age, :type => 'int'))
+end.sync
+
+class User
+  include MarkMapper::Document
+
+  # plain old vanilla scopes with fancy queries
+  scope :johns,   where(:name => 'John')
+
+  # plain old vanilla scopes with hashes
+  scope :bills, :name => 'Bill'
+
+  # dynamic scopes with parameters
+  scope :by_name,  lambda { |name| where(:name => name) }
+  scope :by_ages,  lambda { |low, high| where(:age.ge => low, :age.le => high) }
+
+  # Yep, even plain old methods work as long as they return a query
+  def self.by_tag(tag)
+    where(:tags => tag)
+  end
+
+  # You can even make a method that returns a scope
+  def self.twenties; by_ages(20, 29) end
+
+  key :name, String
+  key :tags, Array
+end
+User.collection.remove # empties collection
+
+User.create(:name => 'John',  :tags => %w[ruby marklogic], :age => 28)
+User.create(:name => 'Bill',  :tags => %w[ruby marklogic], :age => 30)
+User.create(:name => 'Frank', :tags => %w[marklogic],      :age => 35)
+User.create(:name => 'Steve', :tags => %w[html5 css3], :age => 27)
+
+# simple scopes
+pp User.johns.first
+pp User.bills.first
+
+# scope with arg
+pp User.by_name('Frank').first
+
+# scope with two args
+pp User.by_ages(20, 29).all
+
+# chaining class methods on scopes
+pp User.by_ages(20, 40).by_tag('ruby').all
+
+# scope made using method that returns scope
+pp User.twenties.all
+
+MarkMapper.application.drop