statics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93c607e75512692565ed790b398a9478ffa30282245154d9f414217b3eb79480
+  data.tar.gz: 00d476425ece47fa15b14320caa55ab1702100c3c5680fcf0560b47dba859cbd
+SHA512:
+  metadata.gz: b16a0eb5977be24b1f424c1e43257c319f97b22f6e20249626fca83fdec23b07279856b4765cfc1c717f6ffbdcb8f0f6f1d9ba5c3da906d92779a83b58e69b8d
+  data.tar.gz: e41db198c8702cfaaa76f6b1caa167e3cd1fafcef21b39943f8ece0c130b54eda531bd3d964b5a8a82ef519715686ae317f0ebf2370d91763144af4faca65231

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Pablo Crivella.
+
+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.md

@@ -0,0 +1,144 @@
+# Statics
+
+[![Gem](https://img.shields.io/gem/v/statics.svg?style=flat)](http://rubygems.org/gems/statics)
+[![CircleCI](https://img.shields.io/circleci/project/github/pablocrivella/statics.svg)](https://circleci.com/gh/pablocrivella/statics)
+[![Maintainability](https://api.codeclimate.com/v1/badges/935822c7c481aa464186/maintainability)](https://codeclimate.com/github/pablocrivella/statics/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/935822c7c481aa464186/test_coverage)](https://codeclimate.com/github/pablocrivella/statics/test_coverage)
+
+Base class and modules for static models.
+
+Links:
+
+  - [API Docs](https://www.rubydoc.info/gems/statics)
+  - [Contributing](https://github.com/pablocrivella/statics/blob/master/CONTRIBUTING.md)
+  - [Code of Conduct](https://github.com/pablocrivella/statics/blob/master/CODE_OF_CONDUCT.md)
+
+## Requirements
+
+1. [Ruby 2.5.0](https://www.ruby-lang.org)
+
+## Installation
+
+To install, run:
+
+```
+gem install statics
+```
+
+Or add the following to your Gemfile:
+
+```
+gem "statics"
+```
+
+## Usage
+
+Setting the data path:
+
+```ruby
+Statics.configure do |config|
+  config.data_path = "data/"
+end
+```
+
+Defining a static model:
+
+```ruby
+class Post < Statics::Model
+  filename "posts"
+
+  attribute :title, Types::Strict::String
+end
+```
+
+```yml
+# data/posts.yml
+---
+post1:
+  title: "Post 1"
+
+post2:
+  title: "Post 2"
+```
+
+```ruby
+Post.all
+#=> #<Statics::Collection records=[#<Post key=:post1 title="Post 1">, #<Post key=:post2 title="Post 2">]>
+Post.where(title: "Post 1")
+#=> #<Statics::Collection records=[#<Post key=:post1 title="Post 1">]>
+Post.where_not(title: "Post 1")
+#=> #<Statics::Collection records=[#<Post key=:post2 title="Post 2">]>
+Post.find_by(key: :post1)
+#=> #<Post key=:post1 title="Post 1">
+Post[:post1]
+#=> #<Post key=:post1 title="Post 1">
+Post.pluck(:title)
+#=> ["Post 1", "Post 2"]
+post = Post.first
+#=> #<Post key=:post1 title="Post 1">
+post.key
+#=> :post1
+post.title
+#=> "Post 1"
+post.attributes
+#=> {:title=>"Post 1", :key=>:post1}
+```
+
+Defining translatable attributes:
+
+```ruby
+class Post < Statics::Model
+  include Statics::Translatable
+
+  filename "posts"
+
+  attribute :title, Types::Strict::String
+  translatable_attribute :body
+end
+
+```
+
+```yml
+# data/posts.yml
+---
+post1:
+  title: "Post 1"
+  body:
+    en: "Hello!"
+    nl: "Hallo!"
+
+post2:
+  title: "Post 2"
+  body:
+    en: "Bye!"
+    nl: "Doei!"
+
+```
+
+```ruby
+post = Post.first
+# when I18n.locale is :en
+post.body #=> "Hello!"
+post.body(locale: :nl) #=> "Hallo!"
+```
+
+## Tests
+
+To test, run:
+
+```
+bundle exec rspec spec/
+```
+
+## Versioning
+
+Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
+
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+## License
+
+Copyright 2018 [Pablo Crivella](https://pablocrivella.me).
+Read [LICENSE](LICENSE.md) for details.

data/lib/statics.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry/configurable"
+require "dry/struct"
+require "dry/core"
+require "i18n"
+require "yaml"
+require "forwardable"
+
+require "statics/errors"
+require "statics/types"
+require "statics/collection"
+require "statics/model"
+require "statics/translatable"
+require "statics/version"
+
+module Statics
+  extend Dry::Configurable
+
+  setting :data_path, reader: true
+end

data/lib/statics/collection.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Statics
+  class Collection
+    extend Forwardable
+    include Enumerable
+    include Dry::Equalizer(:records)
+
+    def_delegators :@records, :last, :size
+
+    # @param records [Array<Statics::Model>]
+    def initialize(records)
+      @records = records
+    end
+
+    # @return [Statics::Collection]
+    def each(&block)
+      self.class.new(records.each(&block))
+    end
+
+    # @return [Statics::Collection]
+    def select(&block)
+      self.class.new(records.select(&block))
+    end
+
+    # @return [Statics::Collection]
+    def reject(&block)
+      self.class.new(records.reject(&block))
+    end
+
+    # @param conditions [Hash]
+    # @return [Statics::Collection]
+    def where(conditions)
+      select { |record| filter?(record, conditions) }
+    end
+
+    # @param conditions [Hash]
+    # @return [Statics::Collection]
+    def where_not(conditions)
+      reject { |record| filter?(record, conditions) }
+    end
+
+    # @param conditions [Hash]
+    # @return [Statics::Model]
+    def find_by(conditions)
+      find { |record| filter?(record, conditions) }
+    end
+
+    # @return [Array<Symbol>]
+    def keys
+      pluck(:key)
+    end
+
+    # @param attributes [Array<Symbol>]
+    # @return [Array<Object>]
+    def pluck(*attributes)
+      map { |record| record.attributes.slice(*attributes).values }
+        .tap { |result| result.flatten! if attributes.size == 1 }
+    end
+
+    private
+
+    attr_reader :records
+
+    # @param record [Static::Model]
+    # @param conditions [Hash]
+    # @return [true, false]
+    def filter?(record, conditions)
+      conditions.all? do |attribute, value|
+        case value
+        when Array
+          value.include?(record.send(attribute))
+        else
+          record.send(attribute) == value
+        end
+      end
+    end
+  end
+end

data/lib/statics/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Statics
+  class KeyNotFoundError < StandardError
+  end
+end

data/lib/statics/model.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Statics
+  class Model < Dry::Struct
+    transform_keys(&:to_sym)
+
+    defines :filename
+
+    attribute :key, Types::Strict::Symbol.constructor(&:to_sym)
+
+    class << self
+      # @param key [Symbol]
+      # @raise [Statics::KeyNotFoundError] if key is not found.
+      # @return [Statics::Model]
+      def [](key)
+        new(file_contents.fetch(key.to_s) { raise KeyNotFoundError }.merge(key: key.to_sym))
+      end
+
+      # @return [Statics::Collection]
+      def all
+        @all ||= Collection.new(records)
+      end
+
+      def method_missing(method, *args, &block)
+        if Collection.instance_methods.include?(method)
+          all.public_send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        Collection.instance_methods(false).include?(method) || super
+      end
+
+      private
+
+      # @return [Hash]
+      def file_contents
+        @file_contents ||= YAML.load_file(path)
+      end
+
+      # @return [Array<Statics::Model>]
+      def records
+        file_contents.map do |key, attributes|
+          new(attributes.merge(key: key.to_sym))
+        end
+      end
+
+      # @return [String]
+      def path
+        File.join(Statics.data_path, "#{filename}.yml")
+      end
+    end
+  end
+end

data/lib/statics/translatable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Statics
+  module Translatable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def translatable_attributes(*names)
+        names.each { |name| translatable_attribute(name) }
+      end
+
+      def translatable_attribute(name)
+        attribute(name, Types::Map(Types::Strict::Symbol.constructor(&:to_sym), Types::Strict::String))
+        override_translatable_attribute_getter(name)
+      end
+
+      def override_translatable_attribute_getter(name)
+        define_method(name) do |locale: I18n.locale|
+          attributes.dig(name, locale.to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/statics/types.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Types
+  include Dry::Types.module
+end

data/lib/statics/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Statics
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: statics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pablo Crivella
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+- !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'
+description: 
+email:
+- pablocrivella@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/statics.rb
+- lib/statics/collection.rb
+- lib/statics/errors.rb
+- lib/statics/model.rb
+- lib/statics/translatable.rb
+- lib/statics/types.rb
+- lib/statics/version.rb
+homepage: https://github.com/pablocrivella/statics
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/pablocrivella/statics/issues
+  changelog_uri: https://github.com/pablocrivella/statics/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/pablocrivella/statics
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Base class and modules for static models.
+test_files: []