ashikawa-ar 0.1.2

data/lib/ashikawa-ar/exceptions/invalid_record.rb

@@ -0,0 +1,6 @@
+module Ashikawa
+  module AR
+    class InvalidRecord < RuntimeError
+    end
+  end
+end

data/lib/ashikawa-ar/exceptions/unsaved_record.rb

@@ -0,0 +1,6 @@
+module Ashikawa
+  module AR
+    class UnsavedRecord < RuntimeError
+    end
+  end
+end

data/lib/ashikawa-ar/model.rb

@@ -0,0 +1,24 @@
+require "virtus"
+require "aequitas"
+require "active_support/concern"
+require "ashikawa-ar/base"
+require "ashikawa-ar/search"
+require "ashikawa-ar/persistence"
+
+module Ashikawa
+  module AR
+    module Model
+      extend ActiveSupport::Concern
+      include Base
+      include Search
+      include Persistence
+
+      included do
+        class_eval do
+          include Virtus
+          include Aequitas
+        end
+      end
+    end
+  end
+end

data/lib/ashikawa-ar/persistence.rb

@@ -0,0 +1,200 @@
+require "ashikawa-core"
+require "ashikawa-ar/base"
+require "active_support/concern"
+require "ashikawa-ar/exceptions/invalid_record"
+require "ashikawa-ar/exceptions/unsaved_record"
+
+module Ashikawa
+  module AR
+    # Provides Persistence functionality for your model
+    module Persistence
+      extend ActiveSupport::Concern
+      # Save the document to the database returning false if invalid
+      #
+      # @return [self, false] Returns false if not saved
+      # @api public
+      # @example Save the document to the database
+      #     sam = Person.new name: "Sam Lowry"
+      #     sam.save
+      def save;end
+
+      # Save the document to the database throwing an exception if invalid
+      #
+      # @return [self]
+      # @raise [InvalidRecord] if the data is invalid
+      # @api public
+      # @example Save the document to the database
+      #     sam = Person.new name: "Sam Lowry"
+      #     sam.save!
+      def save!;end
+
+      # Save the document to the database even if it is invalid
+      #
+      # @return [self] Returns false if not saved
+      # @api public
+      # @example Save the document to the database
+      #     sam = Person.new name: "Sam Lowry"
+      #     sam.save_without_validation
+      def save_without_validation;end
+
+      # Reload the record from the database
+      #
+      # @return [self]
+      # @raise [UnsavedRecord] if the data is not yet saved
+      # @api public
+      # @example Get the updated version from the database
+      #     sam.reload
+      def reload;end
+
+      # Delete the record from the database
+      #
+      # @return [self]
+      # @raise [UnsavedRecord] if the data is not yet saved
+      # @api public
+      # @example Get the updated version from the database
+      #     sam.delete
+      def delete;end
+
+      # Update a single attribute and write to the database
+      #
+      # @param [String] key Name of the attribute
+      # @param [Object] value Value of the attribute
+      # @return [self]
+      # @raise [UnsavedRecord] if the data is not yet saved
+      # @api public
+      # @example Update the age
+      #     sam.update_attribute "age", 39
+      def update_attribute(key, value);end
+
+      # Updates multiple attributes and write to the database
+      # returning false if they are invalid
+      #
+      # @param [Hash] attributes
+      # @return [self, false]
+      # @raise [UnsavedRecord] if the data is not yet saved
+      # @api public
+      # @example Update the age and favorite color
+      #     sam.update_attributes age: 39, favorite_color: "Green"
+      def update_attributes(attributes);end
+
+      # Updates multiple attributes and write to the database
+      # throwing an exception if they are invalid
+      #
+      # @param [Hash] attributes
+      # @return [self]
+      # @raise [InvalidRecord] if the data is invalid
+      # @raise [UnsavedRecord] if the data is not yet saved
+      # @api public
+      # @example Update the age and favorite color
+      #     sam.update_attributes! age: 39, favorite_color: "Green"
+      def update_attributes!(attributes);end
+
+      # Check, if the object has been persisted
+      #
+      # @return [Boolean]
+      # @api public
+      # @example Check, if sam is persisted
+      #     sam.persisted?
+      def persisted?;end
+
+      # Check, if the object has been deleted
+      #
+      # @return [Boolean]
+      # @api public
+      # @example Check, if sam is deleted
+      #     sam.deleted?
+      def deleted?;end
+
+      # Check, if the object is a new record
+      #
+      # @return [Boolean]
+      # @api public
+      # @example Check, if sam is a new record
+      #     sam.new_record?
+      def new_record?;end
+
+      included do
+        class_eval do
+          def save
+            return false unless self.valid?
+            save_without_validation
+          end
+
+          def save!
+            raise InvalidRecord unless self.valid?
+            save_without_validation
+          end
+
+          def save_without_validation
+            if @id.nil?
+              response = self.class.collection.create self.attributes
+              @id = response.id
+            else
+              self.class.collection[@id] = self.attributes
+            end
+
+            @status = :persisted
+
+            self
+          end
+
+          def check_if_saved!
+            raise UnsavedRecord if @id.nil?
+          end
+
+          def reload
+            check_if_saved!
+            self.attributes = self.class.collection[@id]
+            self
+          end
+
+          def delete
+            check_if_saved!
+            self.class.collection[@id].delete
+            @id = nil
+            @status = :deleted
+            self
+          end
+
+          alias :destroy :delete
+
+          def update_attribute(key, value)
+            check_if_saved!
+            self[key] = value
+            self.save
+          end
+
+          def update_attributes(attributes)
+            check_if_saved!
+            attributes.each_pair do |key, value|
+              self[key] = value
+            end
+
+            self.save
+          end
+
+          def update_attributes!(attributes)
+            check_if_saved!
+            attributes.each_pair do |key, value|
+              self[key] = value
+            end
+
+            self.save!
+          end
+
+          def persisted?
+            @status == :persisted
+          end
+
+          def deleted?
+            @status == :deleted
+          end
+
+          def new_record?
+            @status.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ashikawa-ar/search.rb

@@ -0,0 +1,89 @@
+require "ashikawa-core"
+require "ashikawa-ar/base"
+require "active_support/concern"
+
+module Ashikawa
+  module AR
+    # Provides Search functionality for your model
+    module Search
+      extend ActiveSupport::Concern
+      # Find a document of the collection by ID
+      #
+      # @param [Fixnum] id ID of the document
+      # @return [Instance of Class]
+      # @api public
+      # @example Find a document by its ID
+      #     person = Person.find my_id
+      #     person.name #=> Johnny
+      def self.find(id);end
+
+      # Find a document using an AQL query
+      #
+      # @param [String] query The Query
+      # @return [Array<Instance of Class>]
+      # @api public
+      # @example Find documents with an AQL query
+      #     people = Person.find_by_aql "FOR u IN people RETURN u"
+      #     people.first.name #=> Johnny
+      def self.find_by_aql(query);end
+
+      # Find all documents with the provided attributes
+      #
+      # @param [Hash] example The attributes
+      # @return [Array<Instance of Class>]
+      # @api public
+      # @example Find a document by example
+      #     people = Person.by_example name: "Johnny"
+      #     people.first.name #=> Johnny
+      def self.by_example(example);end
+
+      # Find the first document with the provided attributes
+      #
+      # @param [Hash] example The attributes
+      # @return [Instance of Class]
+      # @api public
+      # @example Find a document by example
+      #     people = Person.first_example name: "Johnny"
+      #     people.name #=> Johnny
+      def self.first_example(example);end
+
+      # Find all documents
+      #
+      # @return [Array<Instance of Class>]
+      # @api public
+      # @example Find all documents
+      #     people = Person.people
+      #     people.first.name #=> Johnny
+      def self.all;end
+
+      included do
+        class_eval do
+          def self.find(id)
+            result = collection[id]
+            from_raw_document result
+          end
+
+          def self.find_by_aql(query)
+            results = database.query query
+            from_raw_documents results
+          end
+
+          def self.by_example(example)
+            results = collection.by_example example: example
+            from_raw_documents results
+          end
+
+          def self.first_example(example)
+            result = collection.first_example example
+            self.new result.to_hash["document"]
+          end
+
+          def self.all
+            results = collection.all
+            from_raw_documents results
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ashikawa-ar/setup.rb

@@ -0,0 +1,18 @@
+require "ashikawa-core"
+
+module Ashikawa
+  module AR
+    def self.raw_setup(name, database)
+      Setup.databases[name] = database
+    end
+
+    def self.setup(name, location)
+      Setup.databases[name] = Ashikawa::Core::Database.new location
+    end
+
+    class Setup
+      class << self; attr_accessor :databases end
+      @databases = {}
+    end
+  end
+end

data/lib/ashikawa-ar/version.rb

@@ -0,0 +1,5 @@
+module Ashikawa
+  module AR
+    VERSION = "0.1.2"
+  end
+end

data/lib/rails/generators/ashikawa/model_generator.rb

@@ -0,0 +1,23 @@
+module Ashikawa
+  module Generators
+    # Generates a Model using Ashikawa::AR for Rails
+    class ModelGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Creates an Ashikawa::AR model"
+      argument :attributes,
+        type: :array,
+        default: [],
+        banner: "attribute[:type] attribute[:type]"
+
+      check_class_collision
+
+      def create_model_file
+        template "model.rb.tt",
+          File.join("app/models", class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/rails/generators/ashikawa/templates/model.rb.tt

@@ -0,0 +1,7 @@
+class <%= class_name %>
+  include Ashikawa::AR::Model
+
+<% attributes.each do |attribute| -%>
+  attribute :<%= attribute.name %><% unless attribute.type.to_s == "string" %>, <%=attribute.type%><%end%>
+<% end -%>
+end

data/spec/examples/person.rb

@@ -0,0 +1,10 @@
+class Person
+  include Ashikawa::AR::Model
+
+  attribute :name
+  attribute :age, Integer
+  attribute :favorite_color
+
+  validates_presence_of :name, :age
+  validates_numericalness_of :age
+end

data/spec/integration/arango_helper.rb

@@ -0,0 +1,27 @@
+RSpec.configure do |config|
+  raise "Could not find arangod. Please install it or check if it is in your path." if `which arangod` == ""
+
+  database_directory = "/tmp/ashikawa-integration"
+  arango_process = false
+
+  config.before(:suite) do
+    puts "Starting ArangoDB"
+    process_id = $$
+
+    Dir.mkdir database_directory unless Dir.exists? database_directory
+    arango_process = IO.popen("arangod #{database_directory} --watch-process #{process_id}")
+
+    sleep 2 # Wait for Arango to start up
+  end
+
+  config.after(:suite) do
+    puts
+    puts "Shutting down ArangoDB"
+
+    Process.kill "INT", arango_process.pid
+    sleep 2  # Wait for Arango to shut down
+    arango_process.close
+
+    `rm -r #{database_directory}/*`
+  end
+end

data/spec/integration/basic_spec.rb

@@ -0,0 +1,22 @@
+require 'integration/spec_helper'
+require 'examples/person.rb'
+
+describe "Basics" do
+  it "should recognize the truth" do
+    true.should be_true
+  end
+
+  describe "basic functionality" do
+    subject { Person }
+
+    it "should provide virtus and aequitas" do
+      person = subject.new name: "George", age: "33"
+      person.age.should == 33
+      person.valid?.should be_true
+    end
+
+    it "should provide the collection name" do
+      subject.model_name.collection.should == "people"
+    end
+  end
+end