scorpio 0.1.0 → 0.2.0

data/lib/scorpio/schema_instance_base/to_rb.rb

@@ -0,0 +1,127 @@
+module Scorpio
+  # base class for representing an instance of an instance described by a schema
+  class SchemaInstanceBase
+    class << self
+      def class_comment
+        lines = []
+
+        description = schema &&
+          schema['description'].respond_to?(:to_str) &&
+          schema['description'].to_str
+        if description
+          description.split("\n", -1).each do |descline|
+            lines << "# " + descline
+          end
+          lines << "#"
+        end
+
+        schema.described_hash_property_names.each_with_index do |propname, i|
+          lines << "#" unless i == 0
+          lines << "# @!attribute [rw] #{propname}"
+
+          property_schema = schema['properties'].respond_to?(:to_hash) &&
+            schema['properties'][propname].respond_to?(:to_hash) &&
+            schema['properties'][propname]
+
+          required = property_schema && property_schema['required']
+          required ||= schema['required'].respond_to?(:to_ary) && schema['required'].include?(propname)
+          lines << "#   @required" if required
+
+          type = property_schema &&
+            property_schema['type'].respond_to?(:to_str) &&
+            property_schema['type'].to_str
+          simple = {'string' => 'String', 'number' => 'Numeric', 'boolean' => 'Boolean', 'null' => 'nil'}
+          rettypes = []
+          if simple.key?(type)
+            rettypes << simple[type]
+          elsif type == 'object' || type == 'array'
+            rettypes = []
+            schema_class = Scorpio.class_for_schema(property_schema)
+            unless schema_class.name =~ /\AScorpio::SchemaClasses::/
+              rettypes << schema_class.name
+            end
+            rettypes << {'object' => '#to_hash', 'array' => '#to_ary'}[type]
+          elsif type
+            # not really valid, but there's some information in there. whatever it is.
+            rettypes << type
+          end
+          # we'll add Object to all because the accessor methods have no enforcement that their value is
+          # of the specified type, and may return anything really. TODO: consider if this is of any value?
+          rettypes << 'Object'
+          lines << "#   @return [#{rettypes.join(', ')}]"
+
+          description = property_schema &&
+            property_schema['description'].respond_to?(:to_str) &&
+            property_schema['description'].to_str
+          if description
+            description.split("\n", -1).each do |descline|
+              lines << "#     " + descline
+            end
+          end
+        end
+        lines.join("\n")
+      end
+
+      def to_rb
+        lines = []
+        description = schema &&
+          schema['description'].respond_to?(:to_str) &&
+          schema['description'].to_str
+        if description
+          description.split("\n", -1).each do |descline|
+            lines << "# " + descline
+          end
+        end
+        lines << "class #{name}"
+        schema.described_hash_property_names.each_with_index do |propname, i|
+          lines << "" unless i == 0
+          property_schema = schema['properties'].respond_to?(:to_hash) &&
+            schema['properties'][propname].respond_to?(:to_hash) &&
+            schema['properties'][propname]
+          description = property_schema &&
+            property_schema['description'].respond_to?(:to_str) &&
+            property_schema['description'].to_str
+          if description
+            description.split("\n", -1).each do |descline|
+              lines << "  # " + descline
+            end
+            lines << "  #" # blank comment line between description and @return
+          end
+
+          required = property_schema && property_schema['required']
+          required ||= schema['required'].respond_to?(:to_ary) && schema['required'].include?(propname)
+          lines << "  # @required" if required
+
+          type = property_schema &&
+            property_schema['type'].respond_to?(:to_str) &&
+            property_schema['type'].to_str
+          simple = {'string' => 'String', 'number' => 'Numeric', 'boolean' => 'Boolean', 'null' => 'nil'}
+          rettypes = []
+          if simple.key?(type)
+            rettypes << simple[type]
+          elsif type == 'object' || type == 'array'
+            rettypes = []
+            schema_class = Scorpio.class_for_schema(property_schema)
+            unless schema_class.name =~ /\AScorpio::SchemaClasses::/
+              rettypes << schema_class.name
+            end
+            rettypes << {'object' => '#to_hash', 'array' => '#to_ary'}[type]
+          elsif type
+            # not really valid, but there's some information in there. whatever it is.
+            rettypes << type
+          end
+          # we'll add Object to all because the accessor methods have no enforcement that their value is
+          # of the specified type, and may return anything really. TODO: consider if this is of any value?
+          rettypes << 'Object'
+          lines << "  # @return [#{rettypes.join(', ')}]"
+
+          lines << "  def #{propname}"
+          lines << "    super"
+          lines << "  end"
+        end
+        lines << "end"
+        lines.join("\n")
+      end
+    end
+  end
+end

data/lib/scorpio/typelike_modules.rb

@@ -1,14 +1,86 @@
 module Scorpio
+  module Typelike
+    def self.modified_copy(other, &block)
+      if other.respond_to?(:modified_copy)
+        other.modified_copy(&block)
+      else
+        return yield(other)
+      end
+    end
+
+    # I could require 'json/add/core' and use #as_json but I like this better.
+    def self.as_json(object)
+      if object.respond_to?(:to_hash)
+        object.map do |k, v|
+          unless k.is_a?(Symbol) || k.respond_to?(:to_str)
+            raise(TypeError, "json object (hash) cannot be keyed with: #{k.pretty_inspect.chomp}")
+          end
+          {k.to_s => as_json(v)}
+        end.inject({}, &:update)
+      elsif object.respond_to?(:to_ary)
+        object.map { |e| as_json(e) }
+      elsif [String, TrueClass, FalseClass, NilClass, Numeric].any? { |c| object.is_a?(c) }
+        object
+      elsif object.is_a?(Symbol)
+        object.to_s
+      elsif object.is_a?(Set)
+        as_json(object.to_a)
+      elsif object.respond_to?(:as_json)
+        as_json(object.as_json)
+      else
+        raise(TypeError, "cannot express object as json: #{object.pretty_inspect.chomp}")
+      end
+    end
+  end
   module Hashlike
+    include Enumerable
+
+    # safe methods which can be delegated to #to_hash (which the includer is assumed to have defined).
+    # 'safe' means, in this context, nondestructive - methods which do not modify the receiver.
+
+    # methods which do not need to access the value.
+    SAFE_KEY_ONLY_METHODS = %w(each_key empty? has_key? include? key? keys length member? size)
+    SAFE_KEY_VALUE_METHODS = %w(< <= > >= any? assoc compact dig each_pair each_value fetch fetch_values has_value? invert key merge rassoc reject select to_h to_proc transform_values value? values values_at)
+    DESTRUCTIVE_METHODS = %w(clear delete delete_if keep_if reject! replace select! shift)
+    # these return a modified copy
+    safe_modified_copy_methods = %w(compact merge)
+    # select and reject will return a modified copy but need the yielded block variable value from #[]
+    safe_kv_block_modified_copy_methods = %w(select reject)
+    SAFE_METHODS = SAFE_KEY_ONLY_METHODS | SAFE_KEY_VALUE_METHODS
+    safe_to_hash_methods = SAFE_METHODS - safe_modified_copy_methods - safe_kv_block_modified_copy_methods
+    safe_to_hash_methods.each do |method_name|
+      define_method(method_name) { |*a, &b| to_hash.public_send(method_name, *a, &b) }
+    end
+    safe_modified_copy_methods.each do |method_name|
+      define_method(method_name) do |*a, &b|
+        Scorpio::Typelike.modified_copy(self) do |object_to_modify|
+          object_to_modify.public_send(method_name, *a, &b)
+        end
+      end
+    end
+    safe_kv_block_modified_copy_methods.each do |method_name|
+      define_method(method_name) do |*a, &b|
+        Scorpio::Typelike.modified_copy(self) do |object_to_modify|
+          object_to_modify.public_send(method_name, *a) do |k, _v|
+            b.call(k, self[k])
+          end
+        end
+      end
+    end
+
     def inspect
       object_group_text = respond_to?(:object_group_text) ? ' ' + self.object_group_text : ''
-      "\#{<#{self.class.name}#{object_group_text}> #{self.map { |k, v| "#{k.inspect} => #{v.inspect}" }.join(', ')}}"
+      "\#{<#{self.class.to_s}#{object_group_text}>#{empty? ? '' : ' '}#{self.map { |k, v| "#{k.inspect} => #{v.inspect}" }.join(', ')}}"
+    end
+
+    def to_s
+      inspect
     end
 
     def pretty_print(q)
       q.instance_exec(self) do |obj|
         object_group_text = obj.respond_to?(:object_group_text) ? ' ' + obj.object_group_text : ''
-        text "\#{<#{obj.class.name}#{object_group_text}>"
+        text "\#{<#{obj.class.to_s}#{object_group_text}>"
         group_sub {
           nest(2) {
             breakable(obj.any? { true } ? ' ' : '')
@@ -27,15 +99,59 @@ module Scorpio
     end
   end
   module Arraylike
+    include Enumerable
+
+    # safe methods which can be delegated to #to_ary (which the includer is assumed to have defined).
+    # 'safe' means, in this context, nondestructive - methods which do not modify the receiver.
+
+    # methods which do not need to access the element.
+    SAFE_INDEX_ONLY_METHODS = %w(each_index empty? length size)
+    # there are some ambiguous ones that are omitted, like #sort, #map / #collect.
+    SAFE_INDEX_ELEMENT_METHODS = %w(| & * + - <=> abbrev assoc at bsearch bsearch_index combination compact count cycle dig drop drop_while fetch find_index first include? index join last pack permutation product reject repeated_combination repeated_permutation reverse reverse_each rindex rotate sample select shelljoin shuffle slice sort take take_while transpose uniq values_at zip)
+    DESTRUCTIVE_METHODS = %w(<< clear collect! compact! concat delete delete_at delete_if fill flatten! insert keep_if map! pop push reject! replace reverse! rotate! select! shift shuffle! slice! sort! sort_by! uniq! unshift)
+
+    # methods (well, method) that returns a modified copy and doesn't need any handling of block variable(s)
+    safe_modified_copy_methods = %w(compact)
+
+    # methods that return a modified copy and do need handling of block variables
+    safe_el_block_methods = %w(reject select)
+
+    SAFE_METHODS = SAFE_INDEX_ONLY_METHODS | SAFE_INDEX_ELEMENT_METHODS
+    safe_to_ary_methods = SAFE_METHODS - safe_modified_copy_methods - safe_el_block_methods
+    safe_to_ary_methods.each do |method_name|
+      define_method(method_name) { |*a, &b| to_ary.public_send(method_name, *a, &b) }
+    end
+    safe_modified_copy_methods.each do |method_name|
+      define_method(method_name) do |*a, &b|
+        Scorpio::Typelike.modified_copy(self) do |object_to_modify|
+          object_to_modify.public_send(method_name, *a, &b)
+        end
+      end
+    end
+    safe_el_block_methods.each do |method_name|
+      define_method(method_name) do |*a, &b|
+        Scorpio::Typelike.modified_copy(self) do |object_to_modify|
+          i = 0
+          object_to_modify.public_send(method_name, *a) do |_e|
+            b.call(self[i]).tap { i += 1 }
+          end
+        end
+      end
+    end
+
     def inspect
       object_group_text = respond_to?(:object_group_text) ? ' ' + self.object_group_text : ''
-      "\#[<#{self.class.name}#{object_group_text}> #{self.map { |e| e.inspect }.join(', ')}]"
+      "\#[<#{self.class.to_s}#{object_group_text}>#{empty? ? '' : ' '}#{self.map { |e| e.inspect }.join(', ')}]"
+    end
+
+    def to_s
+      inspect
     end
 
     def pretty_print(q)
       q.instance_exec(self) do |obj|
         object_group_text = obj.respond_to?(:object_group_text) ? ' ' + obj.object_group_text : ''
-        text "\#[<#{obj.class.name}#{object_group_text}>"
+        text "\#[<#{obj.class.to_s}#{object_group_text}>"
         group_sub {
           nest(2) {
             breakable(obj.any? { true } ? ' ' : '')

data/lib/scorpio/util.rb

@@ -0,0 +1,83 @@
+module Scorpio
+  module Util
+    def stringify_symbol_keys(hash)
+      unless hash.respond_to?(:to_hash)
+        raise(ArgumentError, "expected argument to be a hash; got #{hash.class.inspect}: #{hash.pretty_inspect.chomp}")
+      end
+      Scorpio::Typelike.modified_copy(hash) do |hash_|
+        changed = false
+        out = {}
+        hash_.each do |k, v|
+          if k.is_a?(Symbol)
+            changed = true
+            k = k.to_s
+          end
+          out[k] = v
+        end
+        changed ? out : hash_
+      end
+    end
+
+    def deep_stringify_symbol_keys(object)
+      if object.respond_to?(:to_hash)
+        Scorpio::Typelike.modified_copy(object) do |hash|
+          changed = false
+          out = {}
+          hash.each do |k, v|
+            if k.is_a?(Symbol)
+              changed = true
+              k = k.to_s
+            end
+            out_k = deep_stringify_symbol_keys(k)
+            out_v = deep_stringify_symbol_keys(v)
+            changed = true if out_k.object_id != k.object_id
+            changed = true if out_v.object_id != v.object_id
+            out[out_k] = out_v
+          end
+          changed ? out : hash
+        end
+      elsif object.respond_to?(:to_ary)
+        Scorpio::Typelike.modified_copy(object) do |ary|
+          changed = false
+          out = ary.map do |e|
+            out_e = deep_stringify_symbol_keys(e)
+            changed = true if out_e.object_id != e.object_id
+            out_e
+          end
+          changed ? out : ary
+        end
+      else
+        object
+      end
+    end
+  end
+  extend Util
+
+  module FingerprintHash
+    def ==(other)
+      object_id == other.object_id || (other.respond_to?(:fingerprint) && other.fingerprint == self.fingerprint)
+    end
+
+    alias_method :eql?, :==
+
+    def hash
+      fingerprint.hash
+    end
+  end
+
+  module Memoize
+    def memoize(key, *args_)
+      @memos ||= {}
+      @memos[key] ||= Hash.new do |h, args|
+        h[args] = yield(*args)
+      end
+      @memos[key][args_]
+    end
+
+    def clear_memo(key)
+      @memos ||= {}
+      @memos[key].clear if @memos[key]
+    end
+  end
+  extend Memoize
+end

data/lib/scorpio/util/faraday/response_media_type.rb

@@ -0,0 +1,15 @@
+require 'api_hammer'
+
+# hax
+class Faraday::Response
+  def media_type
+    content_type_attrs.media_type
+  end
+  def content_type_attrs
+    ApiHammer::ContentTypeAttrs.new(content_type)
+  end
+  def content_type
+    _, ct = env.response_headers.detect { |k,v| k =~ /\Acontent[-_]type\z/i }
+    ct
+  end
+end

data/lib/scorpio/version.rb

@@ -1,3 +1,3 @@
 module Scorpio
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/scorpio.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday"
-  spec.add_dependency "faraday_middleware"
   # we are monkey patching json-schema with a fix that has not been merged in a timely fashion.
   spec.add_dependency "json-schema", "~> 2.8"
   spec.add_development_dependency "bundler", "~> 1.12"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorpio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -261,6 +247,8 @@ files:
 - README.md
 - Rakefile
 - bin/documents_to_yml.rb
+- documents/openapis.org/v3/schema.json
+- documents/openapis.org/v3/schema.yml
 - documents/swagger.io/v2/schema.json
 - documents/swagger.io/v2/schema.yml
 - documents/www.googleapis.com/discovery/v1/apis/discovery/v1/rest
@@ -270,12 +258,15 @@ files:
 - lib/scorpio/json-schema-fragments.rb
 - lib/scorpio/json.rb
 - lib/scorpio/json/node.rb
-- lib/scorpio/model.rb
 - lib/scorpio/openapi.rb
 - lib/scorpio/pickle_adapter.rb
+- lib/scorpio/resource_base.rb
 - lib/scorpio/schema.rb
-- lib/scorpio/schema_object_base.rb
+- lib/scorpio/schema_instance_base.rb
+- lib/scorpio/schema_instance_base/to_rb.rb
 - lib/scorpio/typelike_modules.rb
+- lib/scorpio/util.rb
+- lib/scorpio/util/faraday/response_media_type.rb
 - lib/scorpio/version.rb
 - scorpio.gemspec
 homepage: https://github.com/notEthan/scorpio
@@ -298,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.4.5.5
 signing_key: 
 specification_version: 4
 summary: Scorpio REST client