simplify_api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc96340838401375e4e1bff48344bfc3ee11ce5a21746f57c918c5a808d98b84
-  data.tar.gz: 6cc74ddd8af6b5edd9114deb98238a45f585436b9dc153d5e845711cacd417c5
+  metadata.gz: 10ee721abac5c00b5a8a832164ea083368e7092535b7238f2d22f37e05fdd109
+  data.tar.gz: 186733c3df4495ac3c3e3abb7eab1af2e5aaf01c0f0be5e455de49086f4ae00c
 SHA512:
-  metadata.gz: 355bb9df51c2f475bed90e34a8e8003207c240c1fa6cf8756f90de8fbd91290ef4558bfebb4dd660f5a5cd9055e1f3ae729b27c9f7467cf0be4c8dddce910623
-  data.tar.gz: 000c15c38132878e7b8c953888444820776de06c97601143cb05e01cebdb7e3dfd87bb11f82840f61205a4d342b7293075b4a68f55b36b26718f816d3e6ca3f6
+  metadata.gz: 052a2bbf129a7d62c65c3bea2dc9c1bf081208ca62111be3e6cb7674a231b99105ac65d23b51369765f9f2fd7fd53c838acd78bf5ba3b86ca0d59e287cf25e4a
+  data.tar.gz: aa6195bbc6e131f1408024c9fd247f62cca8e8aff327006fd7de30b24f26abc0eae048cc8f6e40deec921daaa300d0a03b9e17731fd1c97d1591b5a294cd8dc8

data/.gitignore

@@ -1,5 +1,7 @@
 /.bundle/
 /Gemfile.lock
+/.ruby-gemset
+/.ruby-version
 /spec/reports/
 /tmp/
 /vendor/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--require rspec/collection_matchers
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,14 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+
+AllCops:
+  Exclude:
+    - 'spec/spec_helper.rb'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bot_engine.gemspec

data/lib/simplify_api/simplify_api.rb

@@ -1,50 +1,55 @@
+# frozen_string_literal: true
+
+# SimplifyApi
 module SimplifyApi
   def self.included(base)
     base.singleton_class.send(:attr_accessor, :attributes)
     base.attributes = {}
-    base.singleton_class.send(:attr_accessor, :mandatory)
-    base.mandatory = []
-    base.singleton_class.send(:attr_accessor, :default)
-    base.default = {}
     base.extend(ClassMethods)
   end
 
+  # ClassMethods
   module ClassMethods
     def attribute(attr, type = Object, **args)
-      raise ArgumentError, "Duplicate attribute #{attr}." if self.attributes[attr]
-      if type.class == Array then
+      raise ArgumentError, "Duplicate attribute #{attr}." if attributes[attr]
+
+      if type.class == Array
         args[:default] = [] unless args[:default]
         args[:array_type] = type[0]
       end
-      self.attributes[attr] = {
+
+      args[:mandatory] ||= false
+      args[:default] ||= nil unless args[:default].class == FalseClass
+
+      attributes[attr] = {
         name: attr.to_s,
-        type: type.class == Class ? type : type.class == Array ? Array : Object,
+        type: type.class == Class ? type : (type.class == Array ? Array : Object),
         params: args
       }
-      self.mandatory << attr if args[:mandatory]
-      self.default["#{attr}".to_sym] = args[:default] if args[:default]
-      self.attributes[attr]
+      attributes[attr]
     end
   end
 
-  def initialize(opts)
-    opts = {self.class.attributes.first[0] => opts} if opts.class == Array
-    opts.each_pair do |k, v|
-      case v
-      when Hash
-        v = self.class.attributes[k.to_sym][:type].new(v)
-      when Array
-        v.collect! do |i|
-          self.class.attributes[k.to_sym][:params][:array_type].new(i)
-        end
+  def initialize(opts = {})
+    opts.symbolize_keys!
+    # opts = { klass_attr.first[0] => opts } if opts.class == Array
+    klass_attr.each_pair do |name, spec|
+      params = spec[:params]
+      if opts.key?(name)
+        value = process_value(name, opts[name])
+        opts.delete(name)
+      else
+        value = params[:default]
       end
-      create_and_set_instance_variable("#{k}", v)
+      raise ArgumentError, "Missing mandatory attribute => #{name}" if params[:mandatory] & value.nil?
+
+      create_and_set_instance_variable(name.to_s, value)
     end
-    raise ArgumentError, "Missing mandatory attributes => #{self.class.mandatory-self.instance_variables}" if not mandatory_attributes_in?
-    self.class.default.each_pair do |k, v|
-      create_and_set_instance_variable(k, v) unless self.instance_variables.include?("@#{k}".to_sym)
+
+    opts.each_pair do |key, value|
+      expanded_value = process_value(key, value)
+      create_and_set_instance_variable(key.to_s, expanded_value)
     end
-    self
   end
 
   def to_h
@@ -54,8 +59,8 @@ module SimplifyApi
       v = instance_variable_get(i)
       if v.class == Array then
         r = []
-        v.each {|a| r << (a.respond_to?(:to_h) ? a.to_h : a) }
-        if self.class.attributes[k][:params][:invisible] then
+        v.each { |a| r << (a.respond_to?(:to_h) ? a.to_h : a) }
+        if klass_attr[k][:params][:invisible] then
           h = r
         else
           h[k] = r
@@ -70,16 +75,28 @@ module SimplifyApi
   def to_json
     self.to_h.to_json
   end
-  
+
+  # method_missing
+  #   Called in case an unexisting method is called.
+  #
+  #   To an assignment call it will create the instance variable.
+  #   Every other call will be passed to super.
+  #
   def method_missing(method_name, *args, &block)
     case method_name
     when /(.*)\=$/
-      create_and_set_instance_variable("#{$1}", args[0])
+      create_and_set_instance_variable($1.to_s, args[0])
     else
       super(method_name, args, block)
     end
   end
 
+  # respond_to_mssing?
+  #   Called to check if an instance respond to a message.
+  #
+  #   It should respond to any assignment call.
+  #   Every other type should be passed to super.
+  #
   def respond_to_missing?(method_name, *args)
     case method_name
     when /(.*)\=$/
@@ -90,19 +107,49 @@ module SimplifyApi
   end
 
   private
+
   def create_and_set_instance_variable(name, value)
-    define_singleton_method("#{name}=") do |arg| 
-      valid_values = self.class.attributes[name.to_sym][:params][:values]
-      raise "Argument Error. Invalid value for #{name} => #{arg}" if valid_values && !valid_values.include?(arg)
+    klass_attr[name.to_sym] = { name: name, type: value.class, params: { default: nil, mandatory: false }} unless klass_attr[name.to_sym]
+
+    define_singleton_method("#{name}=") do |arg|
+      raise ArgumentError, "Invalid value for #{name} => #{arg}" unless valid_value?(name, arg)
+
       instance_variable_set("@#{name}", arg)
     end
-    define_singleton_method("#{name}") do
+
+    define_singleton_method(name.to_s) do
       instance_variable_get("@#{name}")
     end
-    self.send("#{name}=", value)
+
+    send("#{name}=", value)
+  end
+
+  def valid_value?(name, value)
+    return true unless klass_attr[name.to_sym][:params].key?(:values)
+
+    valid_values = klass_attr[name.to_sym][:params][:values]
+    return true if valid_values.include?(value)
+
+    false
+  end
+
+  def process_value(key, value)
+    case value
+    when Hash
+      value = klass_attr[key][:type].new(value)
+    when Array
+      value.collect! do |item|
+        if klass_attr[key][:params].key?(:array_type)
+          klass_attr[key][:params][:array_type].new(item)
+        else
+          item
+        end
+      end
+    end
+    value
   end
 
-  def mandatory_attributes_in?
-    self.class.mandatory.collect {|v| self.instance_variables.include?("@#{v}".to_sym)}.inject(&:&)
+  def klass_attr
+    self.class.attributes
   end
-end
+end

data/lib/simplify_api/support.rb

@@ -0,0 +1,15 @@
+# frozen_strin_literal: true
+
+class Hash
+  def transform_keys!
+    return enum_for(:transform_keys!) { size } unless block_given?
+    keys.each do |key|
+      self[yield(key)] = delete(key)
+    end
+    self
+  end
+
+  def symbolize_keys!
+    transform_keys! { |key| key.to_sym rescue key }
+  end
+end

data/lib/simplify_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimplifyApi
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'
 end

data/lib/simplify_api.rb

@@ -1,3 +1,5 @@
-require 'json'
-
-require 'simplify_api/simplify_api'
+# frozen_string_literal: true
+
+require 'json'
+require 'simplify_api/support'
+require 'simplify_api/simplify_api'

data/simplify_api.gemspec

@@ -1,20 +1,26 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'simplify_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "simplify_api"
-  spec.version       = SimplifyApi::VERSION
-  spec.date          = "2019-05-07"
-  spec.authors       = ["Rodrigo Garcia Couto"]
-  spec.email         = ["r@rodg.co"]
-  spec.summary       = %q{A simple set of tools to help the use of APIs}
-  spec.description   = %q{Fairly usable. A simple set of tools to simplify the use of APIs in Ruby}
-  spec.homepage      = "https://github.com/rodgco/simplify_api"
-  spec.license       = "MIT"
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.require_paths = ["lib"]
+  spec.name = 'simplify_api'
+  spec.version = SimplifyApi::VERSION
+  spec.date = '2019-05-07'
+  spec.authors = ['Rodrigo Garcia Couto']
+  spec.email = ['r@rodg.co']
+  spec.summary = 'A simple set of tools to help the use of APIs'
+  spec.description = 'Fairly usable. A simple set of tools to simplify '\
+    'the use of APIs in Ruby'
+  spec.homepage = 'https://github.com/rodgco/simplify_api'
+  spec.license = 'MIT'
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-collection_matchers'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
 end

data/spec/simplify_api_spec.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: false
+
+require 'simplify_api'
+
+describe SimplifyApi do
+  describe "without attributes" do
+    before(:all) do
+      class Test
+        include SimplifyApi
+      end
+    end
+
+    subject { Test.new }
+
+    it "should work with no attributes" do
+      expect(subject.class).to eq Test
+    end
+
+    it "should accept adhoc parameters" do
+      subject.name = "João da Silva"
+
+      expect(subject.name).to eq "João da Silva"
+      expect(subject).to respond_to :name 
+      expect(Test.attributes).to include(:name)
+    end
+  end
+
+  describe "with attributes" do
+    before(:all) do
+      class Test
+        include SimplifyApi
+        attribute :name, String, mandatory: true
+        attribute :surname, String
+        attribute :country, String, default: "Brazil"
+        attribute :is_admin, values: [true, false], default: false
+        attribute :groups, [String]
+      end
+    end
+
+    it "should fullfil class description" do
+      subject = Test.new(name: "João da Silva")
+
+      expect{ Test.new }.to raise_error ArgumentError
+      expect(subject).to respond_to :name
+      expect(subject).to respond_to :surname
+      expect(subject).to respond_to :country
+      expect(subject.name).to eq "João da Silva"
+      expect(subject.surname).to eq nil
+      expect(subject.country).to eq "Brazil"
+    end
+
+    it "should not accept value out of list" do
+      subject = Test.new(name: "João da Silva")
+
+      expect{ Test.new(name: "João da Silva", is_admin: 1) }.to raise_error ArgumentError
+      expect{ subject.is_admin = 1 }.to raise_error ArgumentError
+    end
+
+    it "should accept adhoc parameters" do
+      subject = Test.new(name: "João da Silva")
+      subject.email = "joao@mailinator.com"
+
+      expect(subject).to respond_to :email
+      expect(subject.email).to eq "joao@mailinator.com"
+      expect(Test.attributes).to include(:email)
+    end
+
+
+    it "should accept array of parameters" do
+      subject = Test.new(name: "João da Silva", groups: ["Leadership", "Apprentice"])
+      subject.languages = ["Portuguese", "English", "Spanish"]
+
+      expect(subject.groups).to have(2).groups
+      expect(subject.languages).to have(3).languages
+    end
+
+    it "should be instatiated with json" do
+      json_value = JSON.parse(%q({ "name": "John Doe", "country": "USA", "email": "joedoe@mailinator.com" }))
+      subject = Test.new(json_value)
+
+      expect(subject.name).to eq "John Doe"
+      expect(subject.country).to eq "USA"
+      expect(subject.email).to eq "joedoe@mailinator.com"
+    end
+
+    it "should be instatiated with json (even complex ones)" do
+      json_value = JSON.parse(%q({ 
+        "name": "John Doe", 
+        "country": "USA", 
+        "email": "joedoe@mailinator.com",
+        "languages": [
+          "English",
+          "German" ]
+      }))
+
+      puts "JSON: #{json_value}"
+      subject = Test.new(json_value)
+
+      expect(subject.name).to eq "John Doe"
+      expect(subject.country).to eq "USA"
+      expect(subject.email).to eq "joedoe@mailinator.com"
+      expect(subject.languages).to have(2).languages
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplify_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Rodrigo Garcia Couto
@@ -14,16 +14,72 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Fairly usable. A simple set of tools to simplify the use of APIs in Ruby
 email:
 - r@rodg.co
@@ -32,12 +88,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - README.md
 - lib/simplify_api.rb
 - lib/simplify_api/simplify_api.rb
+- lib/simplify_api/support.rb
 - lib/simplify_api/version.rb
 - simplify_api.gemspec
+- spec/simplify_api_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/rodgco/simplify_api
 licenses:
 - MIT
@@ -57,8 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple set of tools to help the use of APIs