haveapi-go-client 0.27.3 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8c969dbcf1ded20cb2a187f28b8ac7dfd26ef973e42497c66deee6ff1e2cbf6
-  data.tar.gz: 0ff950f059a4613dc53dfe563be4cc045e0251fa5aff768fc692e742b21a0c0d
+  metadata.gz: 2311cffaf323ff4da73072897c6b07b9d47645d0768a5a897995e7380ae8dd51
+  data.tar.gz: 9a51f18818d70dbf88c0b6b5501b88b17bb14f86ff34e0110f25c948823830d6
 SHA512:
-  metadata.gz: 32465ffef292b06ad088e2945a3b11e20aa64680efcbeac32af0bd8b4237b5adab07e5daf96ac97cc1e36732aca53efb93cdde389eb22e71ff51e1ae7aa0f84a
-  data.tar.gz: 15367ba271f13010f3a03cf53a5fb59a0353bb91d9eda95ed2f79e9b36b8da22705416f3ba9541a2a13a9caf3e1e8a666025afcf928427d7d40d9e5ba0a9d05f
+  metadata.gz: f821f3309a480081de9b71f9fadc8d82793271deae5f4de6b1e6f2de114a9137c69f33f5daa2763772120a10f8ea1e07f64657599785f98b20d3767671a42e59
+  data.tar.gz: ad1a5e7a656d0d2bdf0f79497a2ca53873e8679027fc659d2e59fb22364d2c74eecde36a7f5cea7dddc1da09a87461c24846380ce882ea50054dcf9e5db2e0e0

data/haveapi-go-client.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'haveapi-client', '~> 0.27.3'
+  spec.add_dependency 'haveapi-client', '~> 0.28.0'
 end

data/lib/haveapi/go_client/action.rb

@@ -15,6 +15,10 @@ module HaveAPI::GoClient
     # @return [Array<String>]
     attr_reader :aliases
 
+    # Safe name for generated filenames
+    # @return [String]
+    attr_reader :file_name
+
     # Full action name, including resource
     # @return [String]
     attr_reader :full_dot_name
@@ -58,6 +62,7 @@ module HaveAPI::GoClient
       @resource = resource
       @name = name.to_s
       @prefix = prefix
+      @file_name = safe_file_component(@name)
       @aliases = desc[:aliases]
       @full_dot_name = "#{resource.full_dot_name}##{@name.capitalize}"
       @go_name = camelize(name)
@@ -75,9 +80,8 @@ module HaveAPI::GoClient
 
     # Return action name with all aliases, camelized
     # @return [Array<String>]
-    def all_names
-      yield(go_name)
-      aliases.each { |v| yield(camelize(v)) }
+    def all_names(&)
+      ([go_name] + aliases.map { |v| camelize(v) }).uniq.each(&)
     end
 
     # @return [Boolean]

data/lib/haveapi/go_client/erb_template.rb

@@ -1,8 +1,11 @@
 require 'erb'
 require 'fileutils'
+require 'haveapi/go_client/utils'
 
 module HaveAPI::GoClient
   class ErbTemplate
+    include Utils
+
     def self.render(name, vars)
       t = new(name, vars)
       t.render

data/lib/haveapi/go_client/generator.rb

@@ -1,8 +1,11 @@
 require 'fileutils'
 require 'haveapi/client'
+require 'haveapi/go_client/utils'
 
 module HaveAPI::GoClient
   class Generator
+    include Utils
+
     # Destination directory
     # @return [String]
     attr_reader :dst
@@ -23,8 +26,8 @@ module HaveAPI::GoClient
     # @option opts [String] :package
     def initialize(url, dst, opts)
       @dst = dst
-      @module = opts[:module]
-      @package = opts[:package]
+      @module = opts[:module] && go_module_path(opts[:module])
+      @package = go_package_name(opts[:package])
 
       conn = HaveAPI::Client::Communicator.new(url)
       if opts[:basic_user] && opts[:basic_password]

data/lib/haveapi/go_client/resource.rb

@@ -16,6 +16,10 @@ module HaveAPI::GoClient
     # @return [String]
     attr_reader :full_name
 
+    # Safe full name for generated filenames
+    # @return [String]
+    attr_reader :file_name
+
     # Full name with dots
     # @return [String]
     attr_reader :full_dot_name
@@ -41,6 +45,7 @@ module HaveAPI::GoClient
       @name = name.to_s
       @prefix = prefix
       @full_name = resource_path.map(&:name).join('_')
+      @file_name = resource_path.map { |r| safe_file_component(r.name) }.join('_')
       @full_dot_name = resource_path.map(&:name).map(&:capitalize).join('.')
       @go_name = camelize(name)
       @go_type = full_go_type
@@ -89,7 +94,7 @@ module HaveAPI::GoClient
           package: gen.package,
           resource: self
         },
-        File.join(gen.dst, prefix_underscore("resource_#{full_name}.go"))
+        File.join(gen.dst, prefix_underscore("resource_#{file_name}.go"))
       )
 
       resources.each { |r| r.generate(gen) }
@@ -101,7 +106,7 @@ module HaveAPI::GoClient
             package: gen.package,
             action: a
           },
-          File.join(gen.dst, prefix_underscore("resource_#{full_name}_action_#{a.name}.go"))
+          File.join(gen.dst, prefix_underscore("resource_#{file_name}_action_#{a.file_name}.go"))
         )
       end
     end

data/lib/haveapi/go_client/utils.rb

@@ -1,10 +1,110 @@
+require 'digest/sha1'
+require 'json'
+
 module HaveAPI::GoClient
   module Utils
+    GO_KEYWORDS = %w[
+      break case chan const continue default defer else fallthrough for func go
+      goto if import interface map package range return select struct switch type
+      var
+    ].freeze
+
     # Remove underscores and capitalize names
     # @param v [String]
     # @return [String]
     def camelize(v)
-      v.to_s.split('_').map(&:capitalize).join
+      raw = v.to_s
+      current = raw.split('_').map(&:capitalize).join
+      sanitized = raw.gsub(/[^A-Za-z0-9_]/, '_')
+      candidate = sanitized.split('_').reject(&:empty?).map(&:capitalize).join
+      candidate = 'X' if candidate.empty?
+      candidate = "X#{candidate}" unless go_identifier?(candidate)
+
+      if candidate != current || go_keyword?(candidate)
+        "#{candidate}_#{identifier_hash(raw)}"
+      else
+        candidate
+      end
+    end
+
+    # @param v [String]
+    # @return [String]
+    def safe_file_component(v)
+      raw = v.to_s
+      candidate = raw.gsub(/[^A-Za-z0-9_-]/, '_')
+      candidate = 'x' if candidate.empty?
+
+      if candidate != raw || %w[. ..].include?(candidate)
+        "#{candidate}_#{identifier_hash(raw)}"
+      else
+        candidate
+      end
+    end
+
+    # @param v [String]
+    # @return [String]
+    def go_package_name(v)
+      raw = v.to_s
+      candidate = raw.gsub(/[^A-Za-z0-9_]/, '_')
+      candidate = 'pkg' if candidate.empty? || candidate == '_'
+      candidate = "pkg_#{candidate}" unless go_identifier?(candidate)
+
+      if candidate != raw || go_keyword?(candidate)
+        "#{candidate}_#{identifier_hash(raw)}"
+      else
+        candidate
+      end
+    end
+
+    # @param v [String]
+    # @return [String]
+    def go_module_path(v)
+      raw = v.to_s
+
+      if raw.empty? || raw.match?(/[\s[:cntrl:]]/)
+        raise ArgumentError, "invalid Go module path '#{raw}'"
+      end
+
+      raw
+    end
+
+    # @param v [String]
+    # @return [String]
+    def go_string_literal(v)
+      JSON.generate(v.to_s)
+    end
+
+    # @param v [String]
+    # @return [String]
+    def go_json_tag(v)
+      go_string_literal("json:#{JSON.generate(v.to_s)}")
+    end
+
+    # @param namespace [String]
+    # @param name [String]
+    # @return [String]
+    def go_query_key(namespace, name)
+      go_string_literal("#{namespace}[#{name}]")
+    end
+
+    # @param v [String]
+    # @return [String]
+    def go_comment_text(v)
+      v.to_s.gsub(/[\r\n\t]+/, ' ').gsub(/[[:cntrl:]]+/, ' ').strip
+    end
+
+    protected
+
+    def go_identifier?(v)
+      v.match?(/\A[A-Za-z_][A-Za-z0-9_]*\z/)
+    end
+
+    def go_keyword?(v)
+      GO_KEYWORDS.include?(v)
+    end
+
+    def identifier_hash(v)
+      Digest::SHA1.hexdigest(v.to_s)[0, 8]
     end
   end
 end

data/lib/haveapi/go_client/version.rb

@@ -1,5 +1,5 @@
 module HaveAPI
   module GoClient
-    VERSION = '0.27.3'.freeze
+    VERSION = '0.28.0'.freeze
   end
 end