ant-storage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb612bf83b1e943966b5e0bcb5c6446f8c07aa4c4d3cbb33ba643ad81ea5779c
+  data.tar.gz: ab1d3778a052203c30b8ba6f18cef962e2be020fc5c495edf860defa1f884303
+SHA512:
+  metadata.gz: 9ce1084361d00bc45187e63cf19740f269f01fd8ef8be2cca60bce453c8c9157195a8b1351b0b2d792a3e9118931313dace50b2ea1d8ef2df7ac24cece2e2c80
+  data.tar.gz: d9f58d3fff7c708631b4d7403b89b336ac7c0cb8c5524221e55728112e6f07fdc295d89043361ccaab54443ce542558ce4df85ce49db296460429fbb4a9b7347

data/lib/ant/storage.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'ant/core'
+require_relative 'storage/repository'

data/lib/ant/storage/datasource/exceptions.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'ant/exceptions'
+module Ant
+  module Storage
+    module Exceptions
+      # Exception used when there is an object trying to be created but it
+      # already exists.
+      class ObjectAlreadyExists < Ant::Exceptions::AntFail
+        attr_reader :id
+        def initialize(id, object)
+          @id = id
+          super("Object #{id} already exists", nil, object)
+        end
+      end
+
+      # Exception used when a value on a model violates the restrictions
+      # from the validators.
+      class ValidationErrors < Ant::Exceptions::AntFail
+        def initialize(data)
+          super('Error while validating object', 'ValidationErrors', data)
+        end
+      end
+
+      # Exception used when it is requested an object that can not be found.
+      class ObjectNotFound < Ant::Exceptions::AntFail
+        attr_reader :id
+        def initialize(id)
+          @id = id
+          super("Object #{id} does not exist", nil, id: id)
+        end
+      end
+    end
+  end
+end

data/lib/ant/storage/datasource/id_generators.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Ant
+  module Storage
+    module Datasource
+      # This class was meant to handle the complexity of extracting the
+      # primary key from an object that belongs to a model. This might get
+      # deprecated or suffer a huge refactor.
+      class IDGenerators
+        extend DRY::ResourceInjector
+        def self.[](key)
+          resource(:generators, key)
+        end
+
+        def self.normalize_id(object, key)
+          object.is_a?(Hash) ? object[key] : object
+        end
+
+        id_generator = ->(id, key) { normalize_id(id, key) }
+        register(:generators, :id, id_generator)
+      end
+    end
+  end
+end

data/lib/ant/storage/datasource/json_repository.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'repository'
+require_relative 'id_generators'
+require_relative 'model'
+require 'fileutils'
+
+module Ant
+  module Storage
+    module Datasource
+      # Stores objects as a plain json file inside the specified folder.
+      # Uses this for testing purpouse.
+      class JSONRepository < Repository
+        def self.from_config(conf)
+          folder = conf['storage'].gsub('$name', conf['schema_name'])
+          if conf['schema'].nil?
+            # TODO: decouple use of classes
+            new(folder, conf['primary_key'].to_sym,
+                IDGenerators[:id])
+          else
+            # TODO: This line is very high coupled to ant-nanoservice
+            new(folder, conf['schema']::PRIMARY_KEY, IDGenerators[:id])
+          end
+        end
+
+        def initialize(folder, id, id_generator)
+          @path = folder
+          FileUtils.mkdir_p folder
+          super(id, id_generator)
+        end
+
+        def get(id)
+          path = full_path(id)
+          raise(ObjectNotFound, id) unless File.file?(path)
+
+          contents = File.read(path)
+          JSON.parse(contents, symbolize_names: true)
+        end
+
+        def create_(data)
+          store(data)
+          data
+        end
+
+        def store(data)
+          id = data[@id]
+          File.write(full_path(id), data.to_json)
+        end
+
+        private
+
+        def full_path(id)
+          "#{@path}/#{id}.json"
+        end
+      end
+    end
+  end
+end

data/lib/ant/storage/datasource/model.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'id_generators'
+
+module Ant
+  module Storage
+    module Datasource
+      # Wraps an object inside a model, this will allow to validate that
+      # values are inside the restrictions. It dependes on a repository
+      # for storing values.
+      class Model
+        attr_reader :data
+        attr_writer :data
+
+        # :nocov: #
+        def run_validations!
+          puts 'WARN: model with no validations'
+        end
+        # :nocov: #
+
+        def []=(key, val)
+          @data[key] = val
+        end
+
+        def [](key)
+          @data[key]
+        end
+
+        def store
+          run_validations!
+          @repository.store(@data)
+        end
+
+        def create
+          run_validations!
+          @repository.create(@data)
+        end
+
+        def initialize(data)
+          @data = data
+        end
+
+        attr_writer :repository
+
+        def to_json(options = nil)
+          @data.to_json(options)
+        end
+      end
+
+      # This class is for explicit usage of models without validations
+      class EmptyModel < Model
+        def run_validations!; end
+
+        def to_h
+          @data
+        end
+      end
+    end
+  end
+end

data/lib/ant/storage/datasource/repository.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'exceptions'
+
+module Ant
+  module Storage
+    module Datasource
+      # Base class for repositories. The ID generator might get deprecated.
+      # It provides the interface for storing objects inside any persistance
+      # provider implemented.
+      # TODO: Find a better strategy for primary key handling.
+      class Repository
+        include Exceptions
+        def initialize(id, id_generator)
+          @id = id
+          @id_generator = id_generator
+        end
+
+        def create_initial_object(id)
+          object = { @id => @id_generator.call(id, @id) }
+          object.merge!(id) if id.is_a?(Hash)
+          object
+        end
+
+        def create(id = nil)
+          data = create_initial_object(id)
+          existent = exist?(data[@id])
+          raise(ObjectAlreadyExists.new(data[@id], existent)) if existent
+
+          create_(data)
+        end
+
+        def exist?(id)
+          get(id)
+        rescue ObjectNotFound
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/ant/storage/datasource/sequel.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'repository'
+
+module Ant
+  module Storage
+    module Datasource
+      # Repository that fetch and store objects using a sequel connection
+      # as resource.
+      class Sequel < Repository
+        def initialize(sequel_object, id, id_generator)
+          @sequel = sequel_object
+          super(id, id_generator)
+        end
+
+        def get(id)
+          result = @sequel.where(@id.to_sym => id).first
+          raise(ObjectNotFound, id) if result.nil?
+
+          result
+        end
+
+        def create_(data)
+          id = @sequel.insert(data)
+          data[@id] ||= id
+          data
+        end
+
+        def store(data)
+          data2 = data.dup
+          data2.delete(@id)
+          @sequel.where(@id => data[@id]).update(data2)
+        end
+
+        def connection
+          @sequel
+        end
+      end
+    end
+  end
+end

data/lib/ant/storage/factory.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Ant
+  module Storage
+    # charge of sending objects into storage and fetching also from them.
+    class Factory
+      include Ant::DRY::ResourceInjector
+
+      def initialize(model)
+        @model = model
+      end
+
+      def create(data, source = resource(:default))
+        repository = resource(source)
+        model = @model.new(data)
+        model.repository = repository
+        model.create
+        model
+      end
+
+      def get(id, source = resource(:default))
+        repository = resource(source)
+        data = repository.get(id)
+        model = @model.new(data)
+        model.repository = repository
+        model
+      end
+    end
+  end
+end

data/lib/ant/storage/repository.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'datasource/json_repository'
+require_relative 'datasource/sequel'
+require_relative 'factory'
+
+module Ant
+  module Storage
+    # Singleton storing all the implemented repositories. It also allows to
+    # register new repositories for extension.
+    module Repository
+      extend Ant::DRY::ResourceInjector
+      include Ant::Storage::Datasource
+
+      register(:repositories, :json, JSONRepository)
+      register(:repositories, 'json', JSONRepository)
+      register(:repositories, :sequel, Sequel)
+      register(:repositories, 'sequel', Sequel)
+
+      def self.from_config(schema, sets, default)
+        conf = default.merge(sets || {}).merge('schema' => schema)
+        resource(:repositories, conf['name']).from_config(conf)
+      end
+    end
+  end
+end

data/lib/ant/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ant
+  module Storage
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: ant-storage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gilberto Vargas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ant-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rack-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: |2
+      This module helps to design persistance modules that are very configurable
+      about where and how to store data.
+email:
+- tachoguitar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ant/storage.rb
+- lib/ant/storage/datasource/exceptions.rb
+- lib/ant/storage/datasource/id_generators.rb
+- lib/ant/storage/datasource/json_repository.rb
+- lib/ant/storage/datasource/model.rb
+- lib/ant/storage/datasource/repository.rb
+- lib/ant/storage/datasource/sequel.rb
+- lib/ant/storage/factory.rb
+- lib/ant/storage/repository.rb
+- lib/ant/version.rb
+homepage: https://github.com/tachomex/ant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Implements storage modules for ant framework
+test_files: []