expressir 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f977bc7a798a2d046e6c5add063c3b80eda8f0441eaac5bc06e7eb493d78b225
-  data.tar.gz: f4794f33744e62fb5eb05e1dcb557f97d21afc6c9e34e6fe4af479e8f0a60d0e
+  metadata.gz: c715677941cba222f7a4021ab2e392272e39646afb83c739350a845e0d7f0918
+  data.tar.gz: eb8de33aa98749b1518305b4b34c0f49a685829739ddc79f784b0b2d4d4a68a8
 SHA512:
-  metadata.gz: 4bd6f5a8630de8670088b3e263e6523143241954f10abaa472b3f7421da9b31f8c5f3f77d9f21de66c10bb753da7dcf8c43b68d69bee8e1a24fe41039378a08e
-  data.tar.gz: 9884812d1d614105b3b82c07702a659ce28d3b94a7f4657d1fcc06e4695ef4aa3d6b176624627f82fa179d5735de83d8eba80cd1bcf8a2735c6ed5d32b93cdd9
+  metadata.gz: '0349a84ac72ce995d67070fd27a9f2b543ca0b4f6e10ae5e4f47606287575261b3e76540b55b3517a6273882b6b1a2f94ee2771a9382e7e49c3b584b0cd56146'
+  data.tar.gz: 592ec3ace51fd074f297fd8381ccf9fb0fbaf1d0fa6dfbf7327c28778ef92b07222ae70b93b8ca2e64504815ebdb06d66cf68e32c656b8c5611bb471aa81d9bb

data/README.adoc

@@ -38,13 +38,22 @@ instructions.
 
 [source, sh]
 ----
-./exe/expressir
+$ expressir
 
 Commands:
+  expressir format PATH     # pretty print EXPRESS schema located at PATH
   expressir help [COMMAND]  # Describe available commands or one specific command
   expressir version         # The Expressir Version
 ----
 
+=== Pretty print
+
+[source, sh]
+----
+expressir format schemas/resources/action_schema/action_schema.exp
+----
+
+
 == Development
 
 We are following Sandi Metz's Rules for this gem, you can read
@@ -66,22 +75,31 @@ Setup your environment.
 [source, sh]
 ----
 bin/setup
+git submodule update --init
+bundle exec rake generate
+bundle exec rake compile
 ----
 
 Run the test suite
 
 [source, sh]
 ----
-bin/rspec
+bundle exec rake
 ----
 
 === Grammar updates
-EXPRESS grammar is lined as git submodule to ext/express-grammar
-Shoudl you update it, run ```rake generate```. This command will generate source code for updated native extension using antlr4-native gem.
-Please note that we create several classes on top of antlr4-native output so using embedded rake task is a real requirement.
 
-When new extension is gnerated and tested plase check in updated C++ files to git (```rake generate``` is NOT a CI step, 
-extension source files are pulled from the repo).
+THe EXPRESS grammar is lined as Git submodule at `ext/express-grammar`.
+
+Should you update it, please run `rake generate`. This command will generate
+source code for updated native extension using the `antlr4-native` gem. Please
+note that we create several classes on top of `antlr4-native` output so using
+embedded rake task is a real requirement.
+
+When a new extension is generated and tested, please check in updated C++ files
+to git (`rake generate` is NOT a CI step, extension source files are pulled from
+the repo).
+
 
 == Installation
 

data/exe/format

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "yaml"
-require "expressir/express/parser"
+require "expressir"
 require "expressir/express/formatter"
 require "expressir/express/schema_head_formatter"
 require "expressir/express/hyperlink_formatter"
@@ -9,10 +9,6 @@ require "expressir/express/hyperlink_formatter"
 exp_files = ARGV
 
 repository = Expressir::Express::Parser.from_files(exp_files)
-formatter = Class.new(Expressir::Express::Formatter) do
-  include Expressir::Express::SchemaHeadFormatter
-  include Expressir::Express::HyperlinkFormatter
+repository.schemas.each do |schema|
+  puts schema.to_s(no_remarks: true)
 end
-result = repository.to_hash(formatter: formatter, skip_empty: true)
-
-puts YAML.dump(result)

data/exe/format-test

@@ -75,7 +75,7 @@ formatter = Class.new(Expressir::Express::Formatter) do
   include Expressir::Express::SchemaHeadFormatter
   include Expressir::Express::HyperlinkFormatter
 end
-result = repository.to_hash(formatter: formatter, skip_empty: true)
+result = repository.to_hash(formatter: formatter)
 puts "Repository.to_hash time: #{(Time.now - start).round(2)}s"
 
 # puts YAML.dump(result)

data/lib/expressir/cli.rb

@@ -1,21 +1,19 @@
 require "thor"
-require "expressir/cli/ui"
 
 module Expressir
-  module Cli
-    def self.ui
-      Expressir::Cli::UI
-    end
-
-    def self.start(args)
-      Base.start(args)
+  class Cli < Thor
+    desc "format PATH", "pretty print EXPRESS schema located at PATH"
+    def format(path)
+      repository = Expressir::Express::Parser.from_file(path)
+      repository.schemas.each do |schema|
+        puts "\n(* Expressir formatted schema: #{schema.id} *)\n"
+        puts schema.to_s(no_remarks: true)
+      end
     end
 
-    class Base < Thor
-      desc "version", "The Expressir Version"
-      def version
-        Cli.ui.say("Version #{Expressir::VERSION}")
-      end
+    desc "version", "Expressir Version"
+    def version
+      say(Expressir::VERSION)
     end
   end
 end

data/lib/expressir/model/model_element.rb

@@ -104,20 +104,21 @@ module Expressir
           empty = value.nil? || (value.is_a?(Array) && value.count == 0)
 
           # skip empty values
-          if !empty or include_empty
-            hash[variable.to_s] = if value.is_a? Array
-              value.map do |value|
-                if value.is_a? ModelElement
-                  value.to_hash(root_path: root_path, formatter: formatter, include_empty: include_empty)
-                else
-                  value
-                end
+          next unless !empty or include_empty
+
+          hash[variable.to_s] = case value
+          when Array
+            value.map do |value|
+              if value.is_a? ModelElement
+                value.to_hash(root_path: root_path, formatter: formatter, include_empty: include_empty)
+              else
+                value
               end
-            elsif value.is_a? ModelElement
-              value.to_hash(root_path: root_path, formatter: formatter, include_empty: include_empty)
-            else
-              value
             end
+          when ModelElement
+            value.to_hash(root_path: root_path, formatter: formatter, include_empty: include_empty)
+          else
+            value
           end
         end
 
@@ -132,6 +133,19 @@ module Expressir
         hash
       end
 
+      def to_s
+        to_s(no_remarks: false, formatter: nil)
+      end
+
+      def to_s(no_remarks: false, formatter: nil)
+        formatter ||= Class.new(Expressir::Express::Formatter) do
+          if no_remarks
+            def format_remarks(node); []; end
+          end
+        end
+        formatter.format(self)
+      end
+
       # @param [Hash] hash
       # @param [String] root_path
       # @return [ModelElement]
@@ -142,7 +156,8 @@ module Expressir
         node_class.model_attrs.each do |variable|
           value = hash[variable.to_s]
 
-          node_options[variable] = if value.is_a? Array
+          node_options[variable] = case value
+          when Array
             value.map do |value|
               if value.is_a? Hash
                 self.from_hash(value, root_path: root_path)
@@ -150,7 +165,7 @@ module Expressir
                 value
               end
             end
-          elsif value.is_a? Hash
+          when Hash
             self.from_hash(value, root_path: root_path)
           else
             value
@@ -191,13 +206,14 @@ module Expressir
         self.class.model_attrs.each do |variable|
           value = self.send(variable)
 
-          if value.is_a? Array
+          case value
+          when Array
             value.each do |value|
               if value.is_a? ModelElement
                 value.parent = self
               end
             end
-          elsif value.is_a? ModelElement
+          when ModelElement
             value.parent = self
           end
         end

data/lib/expressir/model/repository.rb

@@ -18,6 +18,7 @@ module Expressir
           *schemas
         ]
       end
+
     end
   end
 end

data/lib/expressir/version.rb

@@ -1,3 +1,3 @@
 module Expressir
-  VERSION = "1.3.3".freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/expressir.rb

@@ -3,10 +3,6 @@ require "expressir/version"
 require "expressir/cli"
 require "expressir/config"
 
-Dir[File.join(__dir__, "expressir", "express", "*.rb")].sort.each do |fea|
-  require fea
-end
-
 # ..........................................................
 # https://bugs.ruby-lang.org/issues/19319
 # The issue is that this bug is fixed for 3.1 and above,
@@ -30,10 +26,6 @@ end
 module Expressir
   class Error < StandardError; end
 
-  def self.ui
-    Expressir::Cli::UI
-  end
-
   def self.root
     File.dirname(__dir__)
   end
@@ -42,3 +34,7 @@ module Expressir
     @root_path ||= Pathname.new(Expressir.root)
   end
 end
+
+Dir[File.join(__dir__, "expressir", "express", "*.rb")].sort.each do |fea|
+  require fea
+end

data/spec/acceptance/version_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe "Expressir" do
       print "\n[#{example.description}] "
       command = %w(version)
       output = capture_stdout { Expressir::Cli.start(command) }
-      expect(output).to include("Version #{Expressir::VERSION}")
+      expect(output).to include(Expressir::VERSION)
 
       # Validate Object Space
       GC.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expressir
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rice
@@ -605,7 +605,6 @@ files:
 - ext/express_parser/extconf.rb
 - lib/expressir.rb
 - lib/expressir/cli.rb
-- lib/expressir/cli/ui.rb
 - lib/expressir/config.rb
 - lib/expressir/express/cache.rb
 - lib/expressir/express/formatter.rb

data/lib/expressir/cli/ui.rb

@@ -1,36 +0,0 @@
-require "thor"
-
-module Expressir
-  module Cli
-    class UI < Thor
-      def self.ask(message)
-        new.ask(message)
-      end
-
-      def self.say(message)
-        new.say(message)
-      end
-
-      def self.error(message)
-        if log_types.include?("error")
-          new.error(message)
-        end
-      end
-
-      def self.info(message)
-        if log_types.include?("info")
-          new.say(message)
-        end
-      end
-
-      def self.run(command)
-        require "open3"
-        Open3.capture3(command)
-      end
-
-      def self.log_types
-        Expressir.configuration.logs.map(&:to_s) || []
-      end
-    end
-  end
-end