fictium 0.1.0

data/lib/fictium/rspec/examples.rb

@@ -0,0 +1,48 @@
+module Fictium
+  module RSpec
+    module Examples
+      extend ActiveSupport::Concern
+
+      included do
+        metadata[:fictium_example] = metadata[:fictium_action].add_example
+        metadata[:fictium_example].summary = metadata[:description]
+
+        context 'with documentation' do
+          let(:metadata) { self.class.metadata }
+
+          it 'documents the example' do
+            expect(metadata[:fictium_example]).to be_present
+            Fictium::RSpec::Autocomplete::Example.process_http_response(
+              metadata[:fictium_example],
+              response
+            )
+          end
+        end
+      end
+
+      class_methods do
+        def default_example
+          metadata[:fictium_example].default = true
+          metadata[:fictium_schema] = Fictium::SchemaEvaluator.new
+        end
+
+        def request_schema(obj)
+          metadata[:fictium_example].request ||= {}
+          metadata[:fictium_example].request[:schema] =
+            metadata[:fictium_schema].format(obj)
+        end
+
+        def response_schema(obj)
+          metadata[:fictium_example].response ||= {}
+          metadata[:fictium_example].response[:schema] =
+            metadata[:fictium_schema].format(obj)
+        end
+
+        def require_request_body!
+          metadata[:fictium_example].request ||= {}
+          metadata[:fictium_example].request[:required] = true
+        end
+      end
+    end
+  end
+end

data/lib/fictium/rspec/proxies/action.rb

@@ -0,0 +1,11 @@
+module Fictium
+  module RSpec
+    module Proxies
+      class Action < Base
+        def additional_arguments
+          { fictium_action: true }
+        end
+      end
+    end
+  end
+end

data/lib/fictium/rspec/proxies/base.rb

@@ -0,0 +1,25 @@
+module Fictium
+  module RSpec
+    module Proxies
+      class Base
+        attr_reader :context, :args, :first_arg, :kwargs
+        def initialize(context, *args, **kwargs)
+          @context = context
+          @first_arg = args.shift
+          @args = args
+          @kwargs = kwargs
+        end
+
+        def evaluate(block, extra_args, extra_kwargs)
+          list_arguments = first_arg + args + extra_args
+          key_arguments = extra_kwargs.merge(kwargs).merge(additional_arguments)
+          context.send(evaluate_method_name, *list_arguments, **key_arguments, &block)
+        end
+
+        def evaluate_method_name
+          :describe
+        end
+      end
+    end
+  end
+end

data/lib/fictium/rspec/proxies/example.rb

@@ -0,0 +1,15 @@
+module Fictium
+  module RSpec
+    module Proxies
+      class Example < Base
+        def additional_arguments
+          { fictium_example: true }
+        end
+
+        def evaluate_method_name
+          :context
+        end
+      end
+    end
+  end
+end

data/lib/fictium/rspec/proxy_handler.rb

@@ -0,0 +1,11 @@
+module Fictium
+  module RSpec
+    module ProxyHandler
+      def describe(subject, *args, **kwargs, &block)
+        return subject.evaluate(block, args, kwargs) if subject.is_a?(Proxies::Base)
+
+        super
+      end
+    end
+  end
+end

data/lib/fictium/rspec/resources.rb

@@ -0,0 +1,41 @@
+module Fictium
+  module RSpec
+    module Resources
+      extend ActiveSupport::Concern
+
+      included do
+        metadata[:fictium_resource] = Fictium::RSpec.document.create_resource
+        Fictium::RSpec::Autocomplete::Resource.name_attributes(
+          metadata[:fictium_resource],
+          metadata[:described_class].name
+        )
+      end
+
+      class_methods do
+        def action(*args, **kwargs)
+          Fictium::RSpec::Proxies::Action.new(self, args, kwargs)
+        end
+
+        def base_path(path)
+          metadata[:fictium_resource].base_path = path
+        end
+
+        def resource_name(name)
+          metadata[:fictium_resource].name = name
+        end
+
+        def resource_summary(summary)
+          metadata[:fictium_resource].summary = summary
+        end
+
+        def resource_description(description)
+          metadata[:fictium_resource].description = description
+        end
+
+        def resource_tags(*tags)
+          metadata[:fictium_resource].tags += tags
+        end
+      end
+    end
+  end
+end

data/lib/fictium/rspec.rb

@@ -0,0 +1,39 @@
+require 'fictium'
+require 'rspec'
+require 'verbs'
+
+require_relative 'rspec/proxy_handler'
+
+require_relative 'rspec/autocomplete/action'
+require_relative 'rspec/autocomplete/example'
+require_relative 'rspec/autocomplete/resource'
+require_relative 'rspec/autocomplete/params'
+
+require_relative 'rspec/resources'
+require_relative 'rspec/actions'
+require_relative 'rspec/examples'
+
+require_relative 'rspec/proxies/base'
+require_relative 'rspec/proxies/action'
+require_relative 'rspec/proxies/example'
+
+module Fictium
+  module RSpec
+    class << self
+      def document
+        @document ||= Fictium::Document.new
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend Fictium::RSpec::ProxyHandler
+  config.include Fictium::RSpec::Resources, type: :controller
+  config.include Fictium::RSpec::Actions, fictium_action: true
+  config.include Fictium::RSpec::Examples, fictium_example: true
+
+  config.after(:suite) do
+    Fictium::RSpec.document.export
+  end
+end

data/lib/fictium/version.rb

@@ -0,0 +1,5 @@
+module Fictium
+  VERSION = '0.1.0'.freeze
+  RAILS_MIN_VERSION = '>= 5.3'.freeze
+  RAILS_MAX_VERSION = '< 6.2'.freeze
+end

data/lib/fictium.rb

@@ -0,0 +1,29 @@
+# Use core extensions on this gem
+require 'active_support'
+
+# JSON Schema validators
+require 'json-schema'
+
+# Core functionalities
+require_relative 'fictium/version'
+
+# Load all objects
+require 'fictium/loader'
+
+# Load Rails specific parts
+if defined?(Rails)
+  require 'fictium/railtie'
+  require 'fictium/engine'
+end
+
+module Fictium
+  class << self
+    def configuration
+      @configuration ||= Fictium::Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/tasks/travis/analyze.rb

@@ -0,0 +1,12 @@
+namespace :travis do
+  desc 'Analizes code quality, for TravisCI'
+  task analyze: %i[spec travis:rubocop travis:brakeman]
+
+  task :rubocop do
+    Bundler.clean_exec('rubocop')
+  end
+
+  task :brakeman do
+    Bundler.clean_exec('brakeman bundle exec brakeman --no-pager --exit-on-error')
+  end
+end

metadata

@@ -0,0 +1,321 @@
+--- !ruby/object:Gem::Specification
+name: fictium
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ramiro Rojo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: verbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.75'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.75'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: 
+email:
+- ramiro.rojo@wolox.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/pull_request_template.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/.keep
+- bin/console
+- bin/setup
+- fictium.gemspec
+- lib/fictium.rb
+- lib/fictium/configurations/configuration.rb
+- lib/fictium/configurations/info.rb
+- lib/fictium/engine.rb
+- lib/fictium/evaluators/parameter_evaluator.rb
+- lib/fictium/evaluators/schema_evaluator.rb
+- lib/fictium/exporters/open_api/schemas/3.0.0.json
+- lib/fictium/exporters/open_api/v3_exporter.rb
+- lib/fictium/exporters/open_api/v3_exporter/content_formatter.rb
+- lib/fictium/exporters/open_api/v3_exporter/example_formatter.rb
+- lib/fictium/exporters/open_api/v3_exporter/param_formatter.rb
+- lib/fictium/exporters/open_api/v3_exporter/path_formatter.rb
+- lib/fictium/exporters/open_api/v3_exporter/path_generator.rb
+- lib/fictium/loader.rb
+- lib/fictium/poros/action.rb
+- lib/fictium/poros/document.rb
+- lib/fictium/poros/example.rb
+- lib/fictium/poros/model.rb
+- lib/fictium/poros/resource.rb
+- lib/fictium/railtie.rb
+- lib/fictium/rspec.rb
+- lib/fictium/rspec/actions.rb
+- lib/fictium/rspec/autocomplete/action.rb
+- lib/fictium/rspec/autocomplete/example.rb
+- lib/fictium/rspec/autocomplete/params.rb
+- lib/fictium/rspec/autocomplete/resource.rb
+- lib/fictium/rspec/examples.rb
+- lib/fictium/rspec/proxies/action.rb
+- lib/fictium/rspec/proxies/base.rb
+- lib/fictium/rspec/proxies/example.rb
+- lib/fictium/rspec/proxy_handler.rb
+- lib/fictium/rspec/resources.rb
+- lib/fictium/version.rb
+- tasks/.keep
+- tasks/travis/analyze.rb
+homepage: https://github.com/Wolox/fictium
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Wolox/fictium
+  source_code_uri: https://github.com/Wolox/fictium
+  changelog_uri: https://github.com/Wolox/fictium/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A gem to generate documentation out of tests.
+test_files: []