slack_resources 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b727e25d899b7c234485101bcabddbb2611a577908ccc887a163a1c4b759020b
-  data.tar.gz: e7b83835d0a3aac090fae3066d63ac1488fc676f6eae4f7e4630dd83a262ba23
+  metadata.gz: f80ba497575cdb836330fa4d5194cf448cd1b8bc81d06710bbbe446fee45ed03
+  data.tar.gz: 4093cb4eb9f3d0fa85deaa49ce53f5135aeb98087dc8c8346d6e89acefa3e13a
 SHA512:
-  metadata.gz: f39ac17a63cb4b892df164ac55bd8def3fd734d3f50a5ed0bb1d25a3f6b21498a43e6b2fe065b8fe41183eecd42a98da2ef0085f2690f2d8c22a417b7b18e6c9
-  data.tar.gz: 41c7cefd5c596a9c2588aa38a91b334a54f6b1f340daaee32db465e04f284390352e7410ee7a0a19f7a5ce1630973e2381a8b59926a3fda089397e3b1694af88
+  metadata.gz: 6a72b6d58185091cc4459f140ad4f805942d970de11b09f8a7b55aec18f01e90e94e95ef0e8a695ab5b26fc312fe8a2435ef64e68ed6cc7758d2658d9cfd07ae
+  data.tar.gz: 13687631b5dd8823d972fa31ca1f506a88a45dbe5e1c3567ff8c3fe1600abd8a6c5dd72a70c35f9ffab71eb498d2d913ce703c543eb41ecfa8413ab5fd90f263

data/.circleci/config.yml

@@ -1,11 +1,62 @@
 version: 2
 jobs:
+  test:
+    parallelism: 1
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - rails-demo-bundle-v2-{{ checksum "Gemfile.lock" }}
+            - rails-demo-bundle-v2-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install --path vendor/bundle
+
+      - save_cache:
+          key: rails-demo-bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Test
+          command: bundle exec rspec -cfd
+      - run:
+          name: Rubocop
+          command: bundle exec rubocop
+
   deploy_gem:
     parallelism: 1
     docker:
-      - image: circleci/ruby-2.5
+      - image: circleci/ruby:2.5.1
     steps:
       - checkout
+      - run:
+          name: Deployment
+          command: ruby .circleci/gem_deployment.rb $RUBYGEMS_API_KEY
+
+  deploy_gem_minor:
+    parallelism: 1
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+      - run:
+          name: Deployment
+          command: ruby .circleci/gem_deployment.rb $RUBYGEMS_API_KEY minor
+
+  deploy_gem_major:
+    parallelism: 1
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+      - run:
+          name: Deployment
+          command: ruby .circleci/gem_deployment.rb $RUBYGEMS_API_KEY major
 
 
 workflows:
@@ -20,3 +71,17 @@ workflows:
                 - deployment/gem
           requires:
             - test
+      - deploy_gem_minor:
+          filters:
+            branches:
+              only:
+                - deployment/gem_minor
+          requires:
+            - test
+      - deploy_gem_major:
+          filters:
+            branches:
+              only:
+                - deployment/gem_major
+          requires:
+            - test

data/.rubocop.yml

@@ -2,6 +2,8 @@ AllCops:
   TargetRubyVersion: 2.5
   Exclude:
     - tmp
+    - lib/slack_resources/generator/event_api/fetch.rb
+    - vendor/**/*
 
 Rails:
   Enabled: true
@@ -27,7 +29,7 @@ Metrics/BlockLength:
     - 'spec/**/*'
 
 Metrics/MethodLength:
-  Max: 40
+  Max: 200
   Exclude:
   - db/migrate/*.rb
 
@@ -35,7 +37,7 @@ Metrics/ModuleLength:
   Max: 150
 
 Metrics/ClassLength:
-  Max: 150
+  Max: 300
   Exclude:
   - db/migrate/*.rb
 
@@ -94,3 +96,9 @@ Naming/UncommunicativeMethodParamName:
 
 Layout/IndentArray:
   EnforcedStyle: consistent
+
+Metrics/ParameterLists:
+  Max: 20
+
+Style/RescueModifier:
+  Enabled: false

data/Gemfile

@@ -2,5 +2,4 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in slack_app_request_handler.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack_resources (0.1.1)
+    slack_resources (0.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,24 +12,24 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.0)
-    concurrent-ruby (1.1.3)
+    concurrent-ruby (1.1.4)
     diff-lcs (1.3)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.5.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (1.2.0)
+    i18n (1.3.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2018.0812)
-    mini_portile2 (2.3.0)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
     netrc (0.11.0)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
     onkcop (0.53.0.2)
       rubocop (>= 0.53.0)
       rubocop-rspec (>= 1.24.0)
@@ -73,7 +73,7 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby

data/lib/generate_event_api_resources.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'slack_resources'
+
+FileUtils.rm_r('./lib/slack_resources/resources/event_api')
+SlackResources::Generator::Writer.new(
+  output_dir: './lib/slack_resources/resources/event_api',
+  data_dir: './lib/slack_resources/raw_data/event_api'
+).execute!

data/lib/slack_resources.rb

@@ -1,3 +1,11 @@
 module SlackResources
-  require 'slack_resources/version'
+  require 'slack_resources/version' if File.exist?('./lib/slack_resources/version')
+
+  require 'slack_resources/generator/event_api/strong_hash'
+  require 'slack_resources/generator/event_api/examples_preparation'
+  require 'slack_resources/generator/event_api/to_schema'
+  require 'slack_resources/generator/event_api/type_detection'
+  require 'slack_resources/generator/event_api/write'
+
+  require 'slack_resources/resources/event_api'
 end

data/lib/slack_resources/generator/event_api/examples_preparation.rb

@@ -0,0 +1,71 @@
+module SlackResources
+  module Generator
+    class ExamplePreparation
+      using StrongHash
+
+      def initialize(examples_dir:, added_examples_dir:)
+        @added_examples_dir = added_examples_dir
+        @examples_dir = examples_dir
+      end
+
+      def execute! # rubocop:disable Metrics/AbcSize
+        single_events = Set.new(raw_examples.map(&:first))
+
+        defined = Set.new
+        event_typed_examples = {}
+        alt_typed_examples = {}
+
+        raw_examples.each do |alt_event_type, event_type, example|
+          example['_raw_example'] = JSON.parse(example.to_json)
+          event_typed_examples.protect_merge!(event_type => example)
+          alt_typed_examples[alt_event_type] = JSON.parse(example.to_json)
+
+          next if defined.add?(event_type)
+
+          single_events.delete(event_type)
+          defined_example = event_typed_examples[event_type]
+
+          Set.new(defined_example.keys + example.keys).each do |k|
+            next if k == '_raw_example'
+
+            defined_value = defined_example[k]
+            additional_value = example[k]
+
+            next if defined_value == additional_value
+
+            if defined_value.is_a?(Hash) && defined_value[TypeDetection::SPECIAL_TYPE] == TypeDetection::MULTIPLE_EXAMPLES
+              (defined_value['items'] << additional_value).sort! { |a, b| a.to_s <=> b.to_s }
+            else
+              defined_example.merge!(
+                k => {
+                  TypeDetection::SPECIAL_TYPE => TypeDetection::MULTIPLE_EXAMPLES,
+                  'target' => k,
+                  'items' => [defined_value, additional_value].sort! { |a, b| a.to_s <=> b.to_s },
+                }
+              )
+            end
+          end
+        end
+
+        alt_typed_examples.select { |k, _| single_events.include?(k) }.protect_merge!(event_typed_examples)
+      end
+
+      private
+
+      def all_files
+        Dir.glob(@added_examples_dir.join('**/*.json')) + Dir.glob(@examples_dir.join('**/*.json'))
+      end
+
+      def raw_examples
+        @raw_examples ||= all_files.map do |f|
+          example = JSON.parse(File.read(f))
+          alt_event_type = File.basename(f, '.json')
+          event_body = example['event'].presence || example
+          event_type = event_body['type']
+
+          [alt_event_type, event_type, event_body.key_ordered]
+        end
+      end
+    end
+  end
+end

data/lib/slack_resources/generator/event_api/strong_hash.rb

@@ -0,0 +1,25 @@
+module SlackResources
+  module Generator
+    module StrongHash
+      refine Hash do
+        def protect_merge!(b)
+          b.keys.map do |new_key|
+            if self[new_key]
+              self[new_key] = b[new_key] if b[new_key].is_a?(Hash) && b[new_key]['type'].is_a?(Array)
+            else
+              self[new_key] = b[new_key]
+            end
+          end
+
+          self
+        end
+
+        def key_ordered
+          keys.sort.inject({}) do |a, k|
+            a.merge!(k => self[k])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack_resources/generator/event_api/to_schema.rb

@@ -0,0 +1,200 @@
+require 'json'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/keys'
+
+module SlackResources
+  module Generator
+    class ToSchema
+      using StrongHash
+
+      def initialize(example:, url:, preset:, key: 'root', defined: {}, defined_used: Set.new, parent: {}, root: nil)
+        @example = JSON.parse(example.to_json).key_ordered
+        @url = url
+        @preset = preset
+        @key = key
+        @defined = defined
+        @defined_used = defined_used
+        @parent = parent
+        @root = root || @example
+      end
+
+      def execute!
+        properties = @example.inject({}) do |a, (prop_name, value)|
+          type = TypeDetection.new(
+            parent_key: @key,
+            to_schema_instance: self,
+            prop_name: prop_name,
+            value: value,
+            container: @example,
+            preset: @preset
+          ).execute!
+
+          @defined_used << type if type.is_a?(String)
+
+          definition =
+            case
+            when TypeDetection.default_type?(type)
+              { 'type' => type }
+            when detail?(type)
+              type
+            when array_type?(type)
+              define_as_array(type, value)
+            else
+              ref_to(type)
+            end
+
+          a.merge(prop_name => definition)
+        end
+
+        [
+          {
+            'type' => 'object',
+            'description' => properties.blank? ? "definition snipped. learn more: #{@url}" : '(defined by script)',
+            'properties' => properties,
+          },
+          @defined,
+          @defined_used,
+        ]
+      end
+
+      def root_schema?
+        @root == @example
+      end
+
+      def root_type
+        @root['type']
+      end
+
+      def root_type_prefix
+        @root_type_prefix ||= root_type.split('_').shift
+      end
+
+      def array_type?(type)
+        type.to_s[0..1] == '[]'
+      end
+
+      def detail?(type)
+        type.is_a?(Hash)
+      end
+
+      def define_as_array(array_type, values)
+        type = array_type[2..-1]
+
+        if TypeDetection.default_type?(type)
+          return {
+            'type' => 'array',
+            'items' => {
+              'type' => type,
+            },
+          }
+        end
+
+        if values.first.is_a?(Hash)
+          to_child_schema(
+            prop_name: type,
+            example: values.first,
+            key: type,
+            parent: @example
+          )
+        elsif values.first.is_a?(String)
+          define_string(type)
+        end
+
+        {
+          'type' => 'array',
+          'items' => ref_to(type),
+        }
+      end
+
+      def define_object(k, v, types)
+        ref_key = k == 'item' ? "#{root_type_prefix}_item" : k
+
+        to_child_schema(
+          prop_name: ref_key,
+          example: v,
+          key: k,
+          parent: types
+        )
+
+        ref_key
+      end
+
+      def define_special_type(prop_name, value, container, const)
+        @defined_used << prop_name
+
+        return prop_name if @parent[prop_name]
+
+        types = value['items'].map { |v| detect_default_type(prop_name, v, container) }.uniq
+
+        @defined[prop_name] =
+          if const
+            { 'type' => normalize_type(types), enum: value['items'].uniq }
+          else
+            { 'type' => normalize_type(types) }
+          end
+
+        prop_name
+      end
+
+      def normalize_type(types)
+        types.size == 1 ? types[0] : types
+      end
+
+      def define_string(prop_name)
+        define_default_type(prop_name, 'string', nil)
+      end
+
+      def define_default_type(prop_name, value, container, const = false)
+        @defined.protect_merge!(
+          prop_name => {
+            'type' => detect_default_type(prop_name, value, container, const),
+          }
+        )
+        @defined_used << prop_name
+
+        ref_to(prop_name)
+      end
+
+      def detect_default_type(prop_name, value, container, const = false)
+        return define_special_type(prop_name, value, container, const) if value.is_a?(Hash) && value[TypeDetection::SPECIAL_TYPE] == TypeDetection::MULTIPLE_EXAMPLES
+
+        case value
+        when Integer
+          'number'
+        when Array
+          'array'
+        when Hash
+          define_object(prop_name, value, container)
+        when true, false
+          'boolean'
+        when nil
+          'null'
+        else
+          'string'
+        end
+      end
+
+      def ref_to(type)
+        { '$ref' => "#/definitions/#{type}" }
+      end
+
+      def to_child_schema(params)
+        prop_name = params.delete(:prop_name)
+        SlackResources::Generator::ToSchema.new(
+          example: @example,
+          url: @url,
+          preset: @preset,
+          key: @key,
+          defined: @defined,
+          defined_used: @defined_used,
+          parent: @parent,
+          root: @root,
+          **params
+        ).execute!.tap do |schema,|
+          @defined_used << prop_name
+          @defined[prop_name] = schema
+        end
+      end
+    end
+  end
+end