avm 0.50.0 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47575dee73ad5721c2ef69d1c6edb61a7b59f61f6fb61052e59d0382df258ec4
-  data.tar.gz: e7ac9159bce593101db01a63fbb890f6a22a899f278cc23f4049f99f9938a158
+  metadata.gz: ee9bdf4f0f96dc20133dd6c00c10ecba0dd48799a37d45d71f3378015448ba4c
+  data.tar.gz: c02fa3d82e35f6e8de9221f2ddd92819da8ecac271239e0127c5b74b43d6b06e
 SHA512:
-  metadata.gz: ba4d0decd31a62c03ef96f66a91e19e7753ef3482808390dd9b4281d23ba5a061d1d35ab9d484de30602237935dde705ad672cfb1b18eff3c8bfdef1044c00e4
-  data.tar.gz: a6f11d49400b9e181741966cda6c140227972e10f34da65546674ffe6432385529e969413584540aa6340e744a532b1d5ad2812d057c0255f0a6b78697a73dbb
+  metadata.gz: 90d0355e8800f3157d3a1a8f90eebf6b95ee47e70be6720e4143cc618e75d8900ce7be84d6b77cc78e4220c9ea02b03b7935950665974372e1c2362f9e5ce2cb
+  data.tar.gz: fef3c1a442cd5bda53b6c562c6d50c48bc409e501cc95440ce876bb82973acf04e91b636a85c8bd4ee21c3e3b5853c8de99da1f66b2abbd027eb6845baf13ea6

data/lib/avm/executables.rb

@@ -14,7 +14,7 @@ module Avm
 
       private
 
-      %w[file git js-beautify latex php-cs-fixer tidy yapf xdg-open].each do |program|
+      %w[xdg-open].each do |program|
         define_method(program.underscore + '_uncached') do
           env.executable(program, '--version')
         end

data/lib/avm/file_formats/base.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'avm/file_formats/utf8_assert'
+require 'eac_fs/file_info'
+require 'ostruct'
+
+module Avm
+  module FileFormats
+    class Base
+      enable_abstract_methods
+
+      def apply(files)
+        old_content = Hash[files.map { |f| [f, File.read(f)] }]
+        ::Avm::FileFormats::Utf8Assert.assert_files(files) { internal_apply(files) }
+        files.map { |f| build_file_result(f, old_content[f]) }
+      end
+
+      def name
+        self.class.name.demodulize
+      end
+
+      def match?(file)
+        match_by_filename?(file) || match_by_type?(file)
+      end
+
+      def valid_basenames
+        constant_or_array('VALID_BASENAMES')
+      end
+
+      def valid_types
+        constant_or_array('VALID_TYPES')
+      end
+
+      private
+
+      def constant_or_array(name)
+        return [] unless self.class.const_defined?(name)
+
+        self.class.const_get(name)
+      end
+
+      def build_file_result(file, old_content)
+        ::OpenStruct.new(file: file, format: self.class,
+                         changed: (old_content != File.read(file)))
+      end
+
+      def match_by_filename?(file)
+        valid_basenames.any? do |valid_basename|
+          file.basename.fnmatch?(valid_basename)
+        end
+      end
+
+      def match_by_type?(file)
+        info = ::EacFs::FileInfo.new(file)
+        return unless info.content_type.type == 'text'
+
+        valid_types.include?(info.content_type.subtype)
+      end
+    end
+  end
+end

data/lib/avm/file_formats/search_formatter.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+require 'eac_ruby_utils/core_ext'
+require 'eac_fs/traversable'
+
+module Avm
+  module FileFormats
+    class SearchFormatter
+      include ::EacFs::Traversable
+      require_sub __FILE__
+      enable_simple_cache
+      enable_speaker
+      enable_listable
+      lists.add_symbol :option, :apply, :recursive, :verbose
+      common_constructor :source_paths, :options, default: [{}] do
+        options.assert_valid_keys(self.class.lists.option.values)
+      end
+
+      def run
+        clear
+        search_files
+        apply
+        show_results
+      end
+
+      private
+
+      def apply
+        speak(:infom, "Applying #{@formats_files.count} format(s)... ")
+        @formats_files.each do |format, files|
+          speak(:infom, "Applying format #{format.name} (Files matched: #{files.count})...")
+          next unless options[OPTION_APPLY]
+
+          @result += format.apply(files)
+        end
+      end
+
+      def traverser_check_file(file)
+        format = find_format(file)
+        speak(:infov, file, format ? format.class : '-')
+        return unless format
+
+        @formats_files[format] ||= []
+        @formats_files[format] << file
+      end
+
+      def clear
+        @formats_files = {}
+        @result = []
+      end
+
+      def find_format(file)
+        formats.each do |c|
+          return c if c.match?(file)
+        end
+        nil
+      end
+
+      def formats_uncached
+        formats_from_registry
+      end
+
+      def formats_from_registry
+        ::Avm::Registry.file_formats.available.reverse.map(&:new)
+      end
+
+      def search_files
+        speak(:infov, 'Directories to search', source_paths.count)
+        source_paths.each do |source_path|
+          speak(:infom, "Searching files on \"#{source_path}\"...")
+          traverser_check_path(source_path)
+        end
+      end
+
+      def show_results
+        changed = @result.select(&:changed)
+        changed.each do |h|
+          speak(:out, h.file.to_s.cyan)
+          speak(:out, " (#{h.format})".yellow)
+          speak(:puts, ' changed'.green)
+        end
+        speak(:infov, 'Files changed', "#{changed.count}/#{@result.count}")
+      end
+
+      def traverser_recursive
+        options[OPTION_RECURSIVE]
+      end
+
+      def speak(method, *method_args)
+        return unless options[OPTION_VERBOSE].to_bool
+
+        send(method, *method_args)
+      end
+    end
+  end
+end

data/lib/avm/file_formats/utf8_assert.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'eac_fs/file_info'
+
+module Avm
+  module FileFormats
+    class Utf8Assert
+      UTF8_CHARSET = 'utf-8'
+      UTF8_CHARSETS = [UTF8_CHARSET, 'us-ascii'].freeze
+
+      class << self
+        def assert_files(files)
+          asserters = files.map { |file| new(file) }
+          begin
+            asserters.each(&:assert)
+            yield
+          ensure
+            asserters.each(&:revert)
+          end
+        end
+      end
+
+      enable_simple_cache
+      common_constructor :path
+
+      def assert
+        return if original_utf8?
+
+        convert_self(original_charset, UTF8_CHARSET)
+      end
+
+      def revert
+        return if original_utf8?
+
+        convert_self(UTF8_CHARSET, original_charset)
+      end
+
+      private
+
+      def original_info_uncached
+        ::EacFs::FileInfo.new(path)
+      end
+
+      def original_charset_uncached
+        return original_info.content_type.charset if original_info.content_type.charset.present?
+
+        raise 'No charset found'
+      rescue StandardError => e
+        raise "Unable to determine the charset of #{path} (#{e.message})"
+      end
+
+      def original_utf8?
+        UTF8_CHARSETS.include?(original_charset)
+      end
+
+      def convert_file(from_path, from_charset, to_path, to_charset)
+        File.open(from_path, "r:#{from_charset}") do |input|
+          File.open(to_path, "w:#{to_charset}") do |output|
+            output.write(input.read)
+          end
+        end
+      end
+
+      def convert_self(from_charset, to_charset)
+        temp = ::Tempfile.new
+        temp.close
+        convert_file(path, from_charset, temp.path, to_charset)
+        ::FileUtils.mv(temp.path, path)
+      end
+    end
+  end
+end

data/lib/avm/file_formats.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module FileFormats
+    require_sub __FILE__
+  end
+end

data/lib/avm/registry/file_formats.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'avm/registry/from_gems'
+
+module Avm
+  module Registry
+    class FileFormats < ::Avm::Registry::FromGems
+    end
+  end
+end

data/lib/avm/registry.rb

@@ -7,8 +7,8 @@ module Avm
   module Registry
     require_sub __FILE__
     enable_listable
-    lists.add_symbol :category, :application_stereotypes, :instances, :launcher_stereotypes,
-                     :runners, :scms, :source_generators, :sources
+    lists.add_symbol :category, :application_stereotypes, :file_formats, :instances,
+                     :launcher_stereotypes, :runners, :scms, :source_generators, :sources
 
     class << self
       enable_simple_cache

data/lib/avm/rspec/setup.rb

@@ -7,7 +7,8 @@ module Avm
   module Rspec
     module Setup
       require_sub __FILE__
-      EXAMPLES = %w[entries_values in_avm_registry not_in_avm_registry].freeze
+      EXAMPLES = %w[avm_file_formats_with_fixtures entries_values in_avm_registry
+                    not_in_avm_registry].freeze
 
       def self.extended(obj)
         obj.setup_examples

data/lib/avm/rspec/shared_examples/avm_file_formats_with_fixtures.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/source_target_fixtures'
+require 'avm/file_formats/search_formatter'
+require 'eac_ruby_utils/core_ext'
+
+::RSpec.shared_examples 'avm_file_formats_with_fixtures' do |the_spec_file|
+  include_examples 'source_target_fixtures', the_spec_file
+
+  def format_files_in_directory(target_dir)
+    ::Avm::FileFormats::SearchFormatter
+      .new([target_dir], recursive: true, apply: true, verbose: false)
+      .run
+  end
+
+  def source_data(source_file)
+    dir = temp_dir
+    source_basename = source_file_basename_without_source_extname(source_file)
+    source_path = dir.join(source_basename)
+    ::FileUtils.cp(source_file, source_path)
+    format_files_in_directory(dir)
+    source_path.read
+  end
+
+  def source_file_basename_without_source_extname(source_file)
+    source_file.to_pathname.basename_sub { |b| b.to_path.gsub(/\.source/, '') }.basename
+  end
+
+  def target_data(target_file)
+    ::File.read(target_file)
+  end
+end

data/lib/avm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Avm
-  VERSION = '0.50.0'
+  VERSION = '0.52.0'
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: avm
 version: !ruby/object:Gem::Version
-  version: 0.50.0
+  version: 0.52.0
 platform: ruby
 authors:
 - Eduardo H. Bogoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aranha-parsers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.4
 - !ruby/object:Gem::Dependency
   name: eac_cli
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +79,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: eac_git
+  name: eac_fs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -78,6 +98,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.3
+- !ruby/object:Gem::Dependency
+  name: eac_git
+  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: eac_ruby_utils
   requirement: !ruby/object:Gem::Requirement
@@ -271,6 +305,10 @@ files:
 - lib/avm/entries/keys_constants_set.rb
 - lib/avm/entries/uri_builder.rb
 - lib/avm/executables.rb
+- lib/avm/file_formats.rb
+- lib/avm/file_formats/base.rb
+- lib/avm/file_formats/search_formatter.rb
+- lib/avm/file_formats/utf8_assert.rb
 - lib/avm/instances.rb
 - lib/avm/instances/base.rb
 - lib/avm/instances/base/auto_values.rb
@@ -317,6 +355,7 @@ files:
 - lib/avm/registry/application_stereotypes.rb
 - lib/avm/registry/application_stereotypes/build_available.rb
 - lib/avm/registry/application_stereotypes/stereotype_builder.rb
+- lib/avm/registry/file_formats.rb
 - lib/avm/registry/from_gems.rb
 - lib/avm/registry/instances.rb
 - lib/avm/registry/launcher_stereotypes.rb
@@ -330,6 +369,7 @@ files:
 - lib/avm/rspec.rb
 - lib/avm/rspec/setup.rb
 - lib/avm/rspec/setup/launcher.rb
+- lib/avm/rspec/shared_examples/avm_file_formats_with_fixtures.rb
 - lib/avm/rspec/shared_examples/entries_values.rb
 - lib/avm/rspec/shared_examples/in_avm_registry.rb
 - lib/avm/rspec/shared_examples/not_in_avm_registry.rb