data_steroid 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 890052af87f8d091be85094d9d7dc9224550556d
+  data.tar.gz: 648d403b075eba488a15c3fffd2c00312bc909f1
+SHA512:
+  metadata.gz: 2da98455efa756076cc9e8f27cb985dc8130d525ccef55d3a0b94fd58c2688972091090d26f94c57e592aea5bfd060bf41feb344911c1bda270dc8411827840b
+  data.tar.gz: 7d430b85ba9cb733bbc8ca13c12d520679b43782b8cf8125df7d8ed1d3b2774df6dcdbd93c6ac5e76ce9cd044e0f60ae08518d57c0154393cf63d51a92b6269d

data/README.md

@@ -0,0 +1,41 @@
+# DataSteroid
+
+DataSteroid is an ODM (Object-Document-Mapper) framework for Google Datastore in Ruby based in Mongoid.
+
+Install
+-------
+```sh
+gem build data_steroid.gem
+gem install data_steroid-<version>.gem
+```
+or
+```ruby
+gem 'data_steroid', '~> 0.4.0', git: 'https://github.com/b2beauty/data_steroid'
+```
+
+Configure
+---------
+```sh
+export DATASTORE_EMULATOR_HOST_PATH=datastore:8181/datastore
+export DATASTORE_EMULATOR_HOST=datastore:8181
+export DATASTORE_DATASET=<project-id>
+export DATASTORE_PROJECT_ID=<project-id>
+```
+
+Use
+-------
+```ruby
+# Define product model product.rb
+class Product
+  include DataSteroid::Entity # inject entity behaviour
+  include DataSteroid::Timestamps # add created and updated properties
+
+  kind 'Product' # Datastore Kind
+
+  property :barcode
+  property :name
+  property :price
+
+  validates :barcode, :name, :price, presence: true
+end
+```

data/lib/data_steroid/criteria.rb

@@ -0,0 +1,9 @@
+module DataSteroid
+  # Inject behaviour for query operations.
+  module Criteria
+    extend ActiveSupport::Concern
+
+    include Queryable
+    include Findable
+  end
+end

data/lib/data_steroid/criteria/findable.rb

@@ -0,0 +1,14 @@
+module DataSteroid
+  module Criteria
+    # Defines behaviour for find operations.
+    module Findable
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def find(id)
+          run query.where('__key__', '=', gcloud_key(id.to_i))
+        end
+      end
+    end
+  end
+end

data/lib/data_steroid/criteria/queryable.rb

@@ -0,0 +1,32 @@
+module DataSteroid
+  module Criteria
+    # Defines behaviour for query operations.
+    module Queryable
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def query
+          datastore.query(kind)
+        end
+
+        def run(query)
+          result = datastore.run query
+          new(result.first) if result.count == 1
+        end
+
+        def fetch(query)
+          result = datastore.run query
+          if result.count > 0
+            result.map { |element| new(element) }
+          else
+            []
+          end
+        end
+
+        def all
+          fetch query
+        end
+      end
+    end
+  end
+end

data/lib/data_steroid/entity.rb

@@ -0,0 +1,69 @@
+require 'google/cloud/datastore/entity'
+
+module DataSteroid
+  # Inject behaviour for Datastore Entity.
+  module Entity
+    extend ActiveSupport::Concern
+
+    include Criteria
+    include Persistable
+    include Properties
+    include Validatable
+
+    include Entity::Initializable
+
+    included do
+      include ActiveModel::Conversion
+      extend ActiveModel::Naming
+
+      class_attribute :kind
+
+      def persisted?
+        id.present?
+      end
+
+      def gcloud_key
+        self.class.datastore.key(kind, id)
+      end
+
+      def to_gcloud
+        hash = {}
+        properties_names.each do |property|
+          hash[property] = send(property)
+        end
+        hash.sort.to_h
+      end
+
+      def to_csv
+        values = to_gcloud.sort.to_h.values.map! do |v| 
+          if v.class == Time
+            v.to_formatted_s(:db)
+          else
+            v.to_s.gsub(',', '')
+          end
+        end
+        values.join(',')
+      end
+
+      def self.kind(kind_name)
+        self.kind = kind_name
+      end
+    end
+
+    class_methods do
+      def datastore
+        @datastore ||= Google::Cloud.new.datastore
+      end
+
+      def datastore_entity
+        datastore.entity kind
+      end
+
+      protected
+
+      def gcloud_key(id)
+        datastore.key(kind, id)
+      end
+    end
+  end
+end

data/lib/data_steroid/entity/initializable.rb

@@ -0,0 +1,20 @@
+module DataSteroid
+  module Entity
+    # Define behaviour for initialization of Entity.
+    module Initializable
+      extend ActiveSupport::Concern
+
+      included do
+        def initialize(options = nil)
+          set_default_values
+          if options.is_a? Google::Cloud::Datastore::Entity
+            properties_names.each { |a| send("#{a}=", options[a.to_s]) }
+            send('id=', options.key.id)
+          elsif options.is_a? ::Hash
+            options.each_pair { |key, value| send("#{key}=", value) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/data_steroid/errors/datastore_error.rb

@@ -0,0 +1,6 @@
+module DataSteroid
+  module Errors
+    class DatastoreError < StandardError
+    end
+  end
+end

data/lib/data_steroid/persistable.rb

@@ -0,0 +1,10 @@
+module DataSteroid
+  # Inject behaviour for poersistation operations.
+  module Persistable
+    extend ActiveSupport::Concern
+
+    include Savable
+    include Deletable
+    include Creatable
+  end
+end

data/lib/data_steroid/persistable/creatable.rb

@@ -0,0 +1,16 @@
+module DataSteroid
+  module Persistable
+    # Defines behaviour for create operations.
+    module Creatable
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def create(params)
+          obj = new params
+          return false if obj.invalid?
+          obj.save ? obj : nil
+        end
+      end
+    end
+  end
+end

data/lib/data_steroid/persistable/deletable.rb

@@ -0,0 +1,18 @@
+module DataSteroid
+  module Persistable
+    # Defines behaviour for delete operations.
+    module Deletable
+      extend ActiveSupport::Concern
+
+      included do
+        def delete
+          @gcloud_entity ||= self.class.datastore_entity
+          if !@gcloud_entity.persisted? && id.present?
+            @gcloud_entity.key = gcloud_key
+          end
+          self.class.datastore.delete @gcloud_entity
+        end
+      end
+    end
+  end
+end

data/lib/data_steroid/persistable/savable.rb

@@ -0,0 +1,49 @@
+module DataSteroid
+  module Persistable
+    # Defines behaviour for save operations.
+    module Savable
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :before_save_methods
+
+        self.before_save_methods = []
+
+        def save
+          return false if invalid?
+
+          before_save_methods.each do |name|
+            send(name)
+          end
+
+          @gcloud_entity ||= self.class.datastore_entity
+
+          to_gcloud.each_pair do |key, value|
+            if key == 'id' && value.present?
+              @gcloud_entity.key = gcloud_key unless @gcloud_entity.persisted?
+              next
+            end
+            if value.present?
+              @gcloud_entity[key] = value
+            elsif @gcloud_entity.properties.exist? key
+              @gcloud_entity.properties.delete key
+            end
+          end
+
+          if (result = self.class.datastore.save(@gcloud_entity).first)
+            send('id=', result.key.id) if id.nil?
+            true
+          else
+            false
+          end
+        end
+      end
+      
+      class_methods do
+        def before_save(method)
+          before_save_methods << method
+        end
+      end
+    end
+  end
+end

data/lib/data_steroid/properties.rb

@@ -0,0 +1,57 @@
+module DataSteroid
+  # Define behaviour to properties of entity.
+  module Properties
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :properties
+
+      self.properties = {}
+
+      property :id # Default property
+
+      def properties=(properties)
+        if properties.is_a? ::Hash
+          properties.each_pair { |key, value| send("#{key}=", value) }
+        else
+          raise Datastore::Errors::DatastoreError.new 'Properties params need is Hash'
+        end
+      rescue
+        raise Datastore::Errors::DatastoreError.new 'Property invalid'
+      end
+
+      def properties_names
+        properties.keys
+      end
+
+      def set_default_values
+        properties.each_pair do |name, options|
+          send("#{name}=", properties[name][:default]) if options.key? :default
+        end
+      end
+    end
+
+    class_methods do
+      protected
+
+      def property(name, options = {})
+        add_property(name.to_s, options)
+      end
+
+      def add_property(name, options)
+        properties[name] = options
+        create_accessors(name)
+      end
+
+      # https://www.leighhalliday.com/ruby-metaprogramming-creating-methods
+      def create_accessors(name)
+        define_method(name) do # Define get method
+          instance_variable_get("@#{name}")
+        end
+        define_method("#{name}=") do |value| # Define set method
+          instance_variable_set("@#{name}", value)
+        end
+      end
+    end
+  end
+end

data/lib/data_steroid/timestamps.rb

@@ -0,0 +1,17 @@
+module DataSteroid
+  # Define behaviour to created_at and updated_at data
+  module Timestamps
+    extend ActiveSupport::Concern
+
+    included do
+      property :created_at, default: DateTime.now
+      property :updated_at
+
+      before_save :update_updated_at
+
+      def update_updated_at
+        self.updated_at = DateTime.now
+      end
+    end
+  end
+end

data/lib/data_steroid/validatable.rb

@@ -0,0 +1,12 @@
+require 'google/cloud/datastore/entity'
+
+module DataSteroid
+  # Add validations to attributes of model.
+  module Validatable
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveModel::Validations
+    end
+  end
+end

data/lib/date_steroid.rb

@@ -0,0 +1,20 @@
+module DataSteroid
+  require 'google/cloud'
+  require 'active_support/concern'
+  require 'active_model'
+
+  require 'data_steroid/criteria/findable'
+  require 'data_steroid/criteria/queryable'
+  require 'data_steroid/criteria'
+  require 'data_steroid/entity/initializable'
+  require 'data_steroid/properties'
+  require 'data_steroid/persistable/creatable'
+  require 'data_steroid/persistable/deletable'
+  require 'data_steroid/persistable/savable'
+  require 'data_steroid/persistable'
+  require 'data_steroid/validatable'
+  require 'data_steroid/entity'
+  require 'data_steroid/errors/datastore_error'
+  require 'data_steroid/persistable'
+  require 'data_steroid/timestamps'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: data_steroid
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Fabio Tomio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-datastore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Simple ODM to Google Datastore based on Mongoid
+email: fabiotomio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/data_steroid/criteria.rb
+- lib/data_steroid/criteria/findable.rb
+- lib/data_steroid/criteria/queryable.rb
+- lib/data_steroid/entity.rb
+- lib/data_steroid/entity/initializable.rb
+- lib/data_steroid/errors/datastore_error.rb
+- lib/data_steroid/persistable.rb
+- lib/data_steroid/persistable/creatable.rb
+- lib/data_steroid/persistable/deletable.rb
+- lib/data_steroid/persistable/savable.rb
+- lib/data_steroid/properties.rb
+- lib/data_steroid/timestamps.rb
+- lib/data_steroid/validatable.rb
+- lib/date_steroid.rb
+homepage: http://github.com/b2beauty/data_steroid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Google Datastore ODM
+test_files: []