eac_tools 0.37.2 → 0.38.0

data/sub/aranha-parsers/lib/aranha/parsers/json/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/base'
+require 'json'
+
+module Aranha
+  module Parsers
+    module Json
+      class Base < ::Aranha::Parsers::Base
+        def data
+          default_data
+        end
+
+        def default_data
+          ::JSON.parse(content)
+        end
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/json.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Aranha
+  module Parsers
+    module Json
+      require_sub __FILE__
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/patches/ofx_parser.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'ofx-parser'
+
+module Aranha
+  module Parsers
+    module Patches
+      module OfxParser
+        module OfxParser
+          def self.included(base)
+            base.class_eval do
+              class << self
+                prepend ClassMethods
+              end
+            end
+          end
+
+          module ClassMethods
+            def build_transaction(transaction)
+              r = super
+              r.currate = (transaction / 'CURRENCY/CURRATE').inner_text
+              r
+            end
+          end
+        end
+
+        module Transaction
+          attr_accessor :currate, :cursym
+        end
+      end
+    end
+  end
+end
+
+require 'eac_ruby_utils/patch'
+
+::EacRubyUtils.patch(::OfxParser::OfxParser, ::Aranha::Parsers::Patches::OfxParser::OfxParser)
+::EacRubyUtils.patch(::OfxParser::Transaction, ::Aranha::Parsers::Patches::OfxParser::Transaction)

data/sub/aranha-parsers/lib/aranha/parsers/patches.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+
+module Aranha
+  module Parsers
+    module Patches
+      ::EacRubyUtils.require_sub __FILE__
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/rspec/setup.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Aranha
+  module Parsers
+    module Rspec
+      module Setup
+        def self.extended(_setup_obj)
+          require 'aranha/parsers/rspec/shared_examples/source_target_fixtures'
+        end
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/rspec/shared_examples/source_target_fixtures.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/rspec/source_target_fixtures_controller'
+require 'aranha/parsers/source_target_fixtures'
+require 'yaml'
+
+RSpec.shared_examples 'source_target_fixtures' do |spec_file| # rubocop:disable Metrics/BlockLength
+  fixtures_controller = ::Aranha::Parsers::Rspec::SourceTargetFixturesController
+                          .new(self, spec_file)
+
+  let(:fixtures_controller) { fixtures_controller }
+  let(:spec_file) { spec_file }
+
+  it 'fixtures directory should exist' do
+    expect(::File.directory?(fixtures_controller.fixtures_dir)).to be true
+  end
+
+  context 'with fixtures directory' do
+    it 'has at least one file' do
+      expect(source_target_fixtures.source_target_files.count).to be > 0 # rubocop:disable Style/NumericPredicate
+    end
+
+    fixtures_controller.source_target_fixtures.source_target_files.each do |st|
+      context "when source file is \"#{::File.basename(st.source)}\"" do
+        if fixtures_controller.write_target_fixtures?
+          it 'writes target data' do
+            sd = sort_results(source_data(st.source))
+            basename = ::Aranha::Parsers::SourceTargetFixtures.source_target_basename(st.source)
+            target_file = File.expand_path("../#{basename}.target#{target_file_extname}", st.source)
+            File.write(target_file, target_content(sd))
+          end
+        else
+          it 'parses data' do
+            assert_source_target_complete(st)
+            sd = source_data(st.source)
+            td = target_data(st.target)
+            expect(sort_results(sd)).to eq(sort_results(td))
+          end
+        end
+      end
+    end
+  end
+
+  delegate :source_target_fixtures, to: :fixtures_controller
+
+  def assert_source_target_complete(source_target)
+    expect(source_target.source).to(be_truthy, "Source not found (Target: #{source_target.target})")
+    expect(source_target.target).to(be_truthy, "Target not found (Source: #{source_target.source})")
+  end
+
+  def source_data(source_file)
+    instance = described_class.new(source_file)
+    return instance.data if instance.respond_to?(:data)
+
+    raise "#{instance} has no \"data\" method. You need to implement \"#{instance}.data\" or " \
+      "\"#{self}.source_data(source_file)\""
+  end
+
+  def sort_results(results)
+    results
+  end
+
+  def target_data(target_file)
+    ::YAML.load_file(target_file)
+  end
+
+  def target_content(data)
+    data.to_yaml
+  end
+
+  def target_file_extname
+    '.yaml'
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/rspec/source_target_fixtures_controller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Aranha
+  module Parsers
+    module Rspec
+      class SourceTargetFixturesController
+        enable_simple_cache
+        common_constructor :example, :spec_file
+
+        def default_fixtures_dir
+          ::File.join(
+            ::File.dirname(spec_file),
+            ::File.basename(spec_file, '.*') + '_files'
+          )
+        end
+
+        def fixtures_dir
+          if example.respond_to?(:fixtures_dir)
+            example.fixtures_dir
+          else
+            default_fixtures_dir
+          end
+        end
+
+        def write_target_fixtures?
+          ENV['WRITE_TARGET_FIXTURES'].to_bool
+        end
+
+        private
+
+        def source_target_fixtures_uncached
+          ::Aranha::Parsers::SourceTargetFixtures.new(fixtures_dir)
+        end
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/rspec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Aranha
+  module Parsers
+    module Rspec
+      require_sub __FILE__
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/source_address/fetch_content_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Aranha
+  module Parsers
+    class SourceAddress
+      class FetchContentError < ::RuntimeError
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/source_address/file.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/source_address/http_get'
+
+module Aranha
+  module Parsers
+    class SourceAddress
+      class File < ::Aranha::Parsers::SourceAddress::HttpGet
+        SCHEME = 'file://'
+
+        class << self
+          def valid_source?(source)
+            source.to_s.start_with?(SCHEME + '/', '/')
+          end
+        end
+
+        def initialize(source)
+          super source.to_s.gsub(/\A#{Regexp.quote(SCHEME)}/, '')
+        end
+
+        def url
+          "#{SCHEME}#{source}"
+        end
+
+        def content
+          ::File.open(source, &:read)
+        end
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/source_address/hash_http_base.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/source_address/fetch_content_error'
+require 'aranha/parsers/source_address/hash_http_base'
+require 'eac_ruby_utils/core_ext'
+require 'faraday_middleware'
+require 'faraday/gzip'
+require 'yaml'
+
+module Aranha
+  module Parsers
+    class SourceAddress
+      class HashHttpBase
+        class << self
+          def http_method
+            const_get 'HTTP_METHOD'
+          end
+
+          def valid_source?(source)
+            source.is_a?(::Hash) &&
+              source.with_indifferent_access[:method].to_s.downcase.strip == http_method.to_s
+          end
+        end
+
+        DEFAULT_BODY = ''
+        DEFAULT_FOLLOW_REDIRECT = true
+        DEFAULT_HEADERS = {}.freeze
+        DEFAULT_PARAMS = {}.freeze
+
+        enable_simple_cache
+
+        common_constructor :source do
+          self.source = source.with_indifferent_access
+        end
+        compare_by :source
+
+        def body
+          param(:body, DEFAULT_BODY)
+        end
+
+        def follow_redirect?
+          param(:follow_redirect, DEFAULT_FOLLOW_REDIRECT)
+        end
+
+        def headers
+          param(:headers, DEFAULT_HEADERS)
+        end
+
+        def url
+          source.fetch(:url)
+        end
+
+        def serialize
+          source.to_yaml
+        end
+
+        # @return [Faraday]
+        def faraday_connection
+          ::Faraday.new do |f|
+            f.request :gzip
+            f.response :follow_redirects if follow_redirect?
+          end
+        end
+
+        def content
+          req = faraday_request
+          return req.body if req.status == 200
+
+          raise ::Aranha::Parsers::SourceAddress::FetchContentError,
+                "Get #{url} returned #{req.status.to_i}"
+        end
+
+        def param(key, default_value)
+          source[key] || params[key] || default_value
+        end
+
+        def params
+          source[:params].if_present(DEFAULT_PARAMS)
+        end
+
+        private
+
+        def faraday_request_uncached
+          faraday_connection.send(self.class.http_method, url) do |req|
+            headers.if_present { |v| req.headers = v }
+            body.if_present { |v| req.body = v }
+          end
+        end
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/source_address/hash_http_get.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/source_address/hash_http_base'
+
+module Aranha
+  module Parsers
+    class SourceAddress
+      class HashHttpGet < ::Aranha::Parsers::SourceAddress::HashHttpBase
+        HTTP_METHOD = :get
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/source_address/hash_http_post.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/source_address/hash_http_base'
+
+module Aranha
+  module Parsers
+    class SourceAddress
+      class HashHttpPost < ::Aranha::Parsers::SourceAddress::HashHttpBase
+        HTTP_METHOD = :post
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/source_address/http_get.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'addressable'
+require 'curb'
+require 'aranha/parsers/source_address/fetch_content_error'
+require 'faraday_middleware'
+
+module Aranha
+  module Parsers
+    class SourceAddress
+      class HttpGet
+        class << self
+          def location_uri(source_uri, location)
+            ::Addressable::URI.join(source_uri, location).to_s
+          end
+
+          def valid_source?(source)
+            source.to_s =~ %r{\Ahttps?://}
+          end
+        end
+
+        attr_reader :source
+
+        def initialize(source)
+          @source = source.to_s
+        end
+
+        def ==(other)
+          self.class == other.class && source == other.source
+        end
+
+        def url
+          source
+        end
+
+        def final_url
+          content unless @final_url
+          @final_url
+        end
+
+        def content
+          conn = ::Faraday.new do |f|
+            f.request :retry # retry transient failures
+            f.response :follow_redirects # follow redirects
+          end
+          c = conn.get(url)
+          return c.body if c.status == 200
+
+          raise ::Aranha::Parsers::SourceAddress::FetchContentError,
+                "Get #{url} returned #{c.status.to_i}"
+        end
+
+        def serialize
+          url
+        end
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/source_address.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+require 'eac_ruby_utils/core_ext'
+require 'yaml'
+
+module Aranha
+  module Parsers
+    class SourceAddress
+      require_sub __FILE__
+
+      class << self
+        SUBS = [
+          ::Aranha::Parsers::SourceAddress::HashHttpGet,
+          ::Aranha::Parsers::SourceAddress::HashHttpPost,
+          ::Aranha::Parsers::SourceAddress::HttpGet,
+          ::Aranha::Parsers::SourceAddress::File
+        ].freeze
+
+        def detect_sub(source)
+          return source.sub if source.is_a?(self)
+
+          SUBS.each do |sub|
+            return sub.new(source) if sub.valid_source?(source)
+          end
+          raise "No content fetcher found for source \"#{source}\""
+        end
+
+        def deserialize(string)
+          new(string =~ %r{\A[a-z]+://} ? string.strip : ::YAML.load(string)) # rubocop:disable Security/YAMLLoad
+        end
+
+        def from_file(path)
+          deserialize(::File.read(path))
+        end
+      end
+
+      enable_simple_cache
+      common_constructor :source
+      delegate :content, :url, to: :sub
+
+      def to_s
+        sub.url
+      end
+
+      def serialize
+        sub.serialize.strip + "\n"
+      end
+
+      private
+
+      def sub_uncached
+        self.class.detect_sub(source)
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/source_target_fixtures/source_target_file.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Aranha
+  module Parsers
+    class SourceTargetFixtures
+      class SourceTargetFile
+        common_constructor :owner, :basename
+
+        def source
+          owner.source_file(basename)
+        end
+
+        def target
+          owner.target_file(basename)
+        end
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/source_target_fixtures.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/string'
+
+module Aranha
+  module Parsers
+    # Lists pairs of source/target files in a directory.
+    class SourceTargetFixtures
+      require_sub __FILE__
+
+      class << self
+        def source_target_basename(file)
+          m = /^(.+)\.(?:source|target)(?:\..+)?$/.match(File.basename(file))
+          m ? m[1] : nil
+        end
+      end
+
+      attr_reader :fixtures_directory
+
+      def initialize(fixtures_directory)
+        @fixtures_directory = fixtures_directory
+      end
+
+      def source_target_files
+        sources_targets_basenames.map do |basename|
+          ::Aranha::Parsers::SourceTargetFixtures::SourceTargetFile.new(self, basename)
+        end
+      end
+
+      def source_files
+        r = []
+        source_target_files.each do |st|
+          r << st.source if st.source
+        end
+        r
+      end
+
+      def target_files
+        r = []
+        source_target_files.each do |st|
+          r << st.target if st.target
+        end
+        r
+      end
+
+      def target_file(basename)
+        fixture_file(basename, 'target')
+      end
+
+      def source_file(basename)
+        fixture_file(basename, 'source')
+      end
+
+      private
+
+      def fixture_file(basename, suffix)
+        prefix = "#{basename}.#{suffix}"
+        Dir.foreach(fixtures_directory) do |item|
+          next if %w[. ..].include?(item)
+          return File.expand_path(item, fixtures_directory) if item.starts_with?(prefix)
+        end
+        nil
+      end
+
+      def sources_targets_basenames
+        basenames = Set.new
+        Dir.foreach(fixtures_directory) do |item|
+          next if %w[. ..].include?(item)
+
+          b = self.class.source_target_basename(item)
+          basenames << b if b.present?
+        end
+        basenames
+      end
+    end
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Aranha
+  module Parsers
+    VERSION = '0.14.4'
+  end
+end

data/sub/aranha-parsers/lib/aranha/parsers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+
+module Aranha
+  module Parsers
+    ::EacRubyUtils.require_sub __FILE__
+  end
+end

data/sub/aranha-parsers/spec/lib/aranha/parsers/rspec/shared_examples/source_target_fixtures_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+::RSpec.describe 'RSpec.shared_examples(\'source_target_fixtures\')' do # rubocop:disable RSpec/DescribeClass
+  include_examples 'source_target_fixtures', __FILE__
+
+  def source_data(source_file)
+    ::File.read(source_file)
+  end
+end

data/sub/aranha-parsers/spec/lib/aranha/parsers/rspec/shared_examples/source_target_fixtures_spec_files/fixture1.source.txt

@@ -0,0 +1 @@
+Isto é um fixture.

data/sub/aranha-parsers/spec/lib/aranha/parsers/rspec/shared_examples/source_target_fixtures_spec_files/fixture1.target.yaml

@@ -0,0 +1,3 @@
+--- 'Isto é um fixture.
+
+  '

data/sub/aranha-parsers/spec/lib/aranha/parsers/source_address/http_get_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/source_address/http_get'
+
+RSpec.describe ::Aranha::Parsers::SourceAddress::HttpGet do
+  SOURCE_URI = 'http://example.net/abc' # rubocop:disable RSpec/LeakyConstantDeclaration
+
+  describe '#location_uri' do
+    [
+      { location: 'http://example.net/def', expected: 'http://example.net/def' },
+      { location: '/def', expected: 'http://example.net/def' }
+    ].each do |stub|
+      context "when source_uri is \"#{SOURCE_URI}\" and location is \"#{stub.fetch(:location)}\"" do
+        it "return #{stub.fetch(:expected)}" do
+          expect(described_class.location_uri(SOURCE_URI, stub.fetch(:location)))
+            .to eq(stub.fetch(:expected))
+        end
+      end
+    end
+  end
+end