ashikawa-ar 0.1.2

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use @$(basename `pwd`) --create

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+script: "rake ci"

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing
+
+When you want to write code for the project, please follow these guidelines:
+
+1. Claim the ticket: Tell us that you want to work on a certain ticket, we will assign it to you (We don't want two people to work on the same thing ;) )
+2. Write an Integration Test: Describe what you want to do (our integration tests touch the database)
+3. Implement it: Write a unit test, check that it fails, make the test pass – repeat (our unit tests don't touch the database)
+4. Write Documentation for it.
+5. Check with `rake` that everything is fine and send the Pull Request :)
+
+## How to get started developing
+
+Getting started is easy, just follow these steps.
+
+### In a nutshell
+
+* Clone the project.
+* `cd` into the folder and run `bundle` 
+* `rake` and see all tests passing
+* Happy coding!
+
+### Detailed description
+
+Make sure you are running Ruby 1.9.x (or JRuby/Rubinius in 1.9 mode) and clone the latest snapshot into a directory of your choice.
+
+Change into the project directory. Run `bundle` to get all dependencies (do a `gem install bundler` before if you don't have bundler installed).
+
+Now you can run `rake` to see all tests passing (hopefully). Happy coding!
+
+You can also start up yard for documentation: `rake yard:server`
+
+### Guard
+
+Guard is a tool for comfortable development. If you want to use it for development, you have to first start an instance of ArangoDB and then start guard with `guard`. This will:
+
+* Run a documentation server on `http://localhost:8808`
+* Run `bundle` whenever you change the dependencies
+* Run the integration and unit tests whenever you change a file in the lib or spec directory
+
+### Continuous Integration
+
+Our tests are run on Travis CI, the build status is displayed above. **Please note** that it only runs the unit tests and not the integration tests, because that would require ArangoDB to be installed on the Travis CI boxes. *Therefore green doesn't neccessarily mean green* (which is unfortunate). Therefore it is important that you run the integration tests on your local machine before sending the pull requests.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ashikawa-ar.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,18 @@
+guard 'bundler' do
+  watch(/^.+\.gemspec/)
+end
+
+guard 'yard' do
+  watch(%r{lib/.+\.rb})
+end
+
+guard 'rspec', :version => 2, :spec_paths => "spec/unit" do
+  watch(%r{lib/.+\.rb})
+  watch(%r{spec/.+\.rb})
+end
+
+guard 'rspec', :version => 2, :spec_paths => "spec/integration" do
+  watch(%r{lib/.+\.rb})
+  watch(%r{spec/.+\.rb})
+end
+

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,15 @@
+# Ashikawa::AR
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/triAGENS/ashikawa-ar)
+[![Build Status](https://secure.travis-ci.org/triAGENS/ashikawa-ar.png?branch=master)](http://travis-ci.org/triAGENS/ashikawa-ar)
+[![Dependency Status](https://gemnasium.com/triAGENS/ashikawa-ar.png)](https://gemnasium.com/triAGENS/ashikawa-ar)
+
+Ashikawa::AR is an ArangoDB ODM for Ruby using the ActiveRecord Pattern.
+
+## How to use it
+
+For a detailed description of Ashikawa::AR please refer to the [documentation](http://rdoc.info/github/triAGENS/ashikawa-ar/master/frames).
+
+# Contributing
+
+If you want to contribute to the project, see CONTRIBUTING.md for details.

data/Rakefile

@@ -0,0 +1,54 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec"
+require "rspec/core/rake_task"
+
+namespace :spec do
+  desc "Run the integration tests. Requires ArangoDB."
+  RSpec::Core::RakeTask.new(:integration) do |spec|
+    spec.rspec_opts = "--require integration/arango_helper.rb"
+    spec.pattern = "spec/integration/*_spec.rb"
+  end
+
+  desc "Run the unit tests"
+  RSpec::Core::RakeTask.new(:unit) do |spec|
+    spec.pattern = "spec/unit/*_spec.rb"
+  end
+
+  desc "Run all tests. Requires ArangoDB"
+  task :all => [:integration, :unit]
+end
+
+desc "check if gems are up to date"
+task :dependencies do
+  dependency_status = `bundle outdated`
+  if dependency_status.include? "up to date"
+    puts "Dependencies up to date."
+  else
+    puts dependency_status
+    exit(1)
+  end
+end
+
+namespace :yard do
+  desc "generate the documentation"
+  task :generate do
+    `yard`
+  end
+
+  desc "start the documentation server on port 8808"
+  task :server do
+    `yard server --reload`
+  end
+
+  desc "get statistics on the yard documentation"
+  task :stats do
+    `yard stats`
+  end
+end
+
+desc "Run Unit Tests - no ArangoDB required"
+task :ci => ["spec:unit"]
+
+desc "Run all tests - ArangoDB required"
+task :default => ["spec:all"]

data/ashikawa-ar.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ashikawa-ar/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["moonglum"]
+  gem.email         = ["moonglum@moonbeamlabs.com"]
+  gem.description   = %q{ArangoDB ODM for Ruby using the ActiveRecord Pattern}
+  gem.summary       = %q{ArangoDB ODM for Ruby using the ActiveRecord Pattern.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ashikawa-ar"
+  gem.require_paths = ["lib"]
+  gem.version       = Ashikawa::AR::VERSION
+
+  gem.add_dependency "ashikawa-core", "~> 0.3.0"
+  gem.add_dependency "virtus", "~> 0.5.2"
+  gem.add_dependency "aequitas", "~> 0.0.2"
+  gem.add_dependency "activesupport", "~> 3.2.8"
+  gem.add_dependency "activemodel", "~> 3.2.8"
+
+  # Development Dependencies
+  unless defined? PLATFORM and PLATFORM == 'java'
+    gem.add_development_dependency "redcarpet", "~> 2.1.1"
+  end
+
+  gem.add_development_dependency "rake", "~> 0.9.2.2"
+  gem.add_development_dependency "rspec", "~> 2.11.0"
+  gem.add_development_dependency "yard", "~> 0.8.2.1"
+
+  gem.add_development_dependency "guard", "~> 1.3.3"
+  gem.add_development_dependency "guard-rspec", "~> 1.2.1"
+  gem.add_development_dependency "guard-bundler", "~> 1.0.0"
+  gem.add_development_dependency "guard-yard", "~> 2.0.0"
+  gem.add_development_dependency "rb-fsevent", "~> 0.9.1"
+end

data/lib/ashikawa-ar.rb

@@ -0,0 +1,8 @@
+require "ashikawa-ar/version"
+require "ashikawa-ar/setup"
+require "ashikawa-ar/model"
+
+module Ashikawa
+  module AR
+  end
+end

data/lib/ashikawa-ar/base.rb

@@ -0,0 +1,48 @@
+require "active_support/concern"
+require "active_support/core_ext/object/blank"
+require "active_model/naming"
+require "active_model/conversion"
+
+module Ashikawa
+  module AR
+    module Base
+      extend ActiveSupport::Concern
+
+      included do
+        class_eval do
+          extend ActiveModel::Naming
+          include ActiveModel::Conversion
+
+          attr_accessor :id
+          attr_accessor :status
+
+          def self.collection_name
+            self.model_name.collection
+          end
+
+          def self.collection
+            database[collection_name]
+          end
+
+          def self.database
+            Setup.databases[:default]
+          end
+
+          def self.from_raw_document(raw_document)
+            document = self.new raw_document.to_hash
+            document.id = raw_document.id
+            document.status = :persisted
+            document
+          end
+
+          def self.from_raw_documents(raw_documents)
+            raw_documents.map do |raw_document|
+              from_raw_document raw_document
+            end
+          end
+        end
+      end
+    end
+  end
+end
+