ucasy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17ebb25fba3f59ded4ef25011e7f2d43854619c775f9c2f2b2c3b64ac9bccd51
+  data.tar.gz: 99d93a1383bc0ec0695cd432c6016b7fc80677b8f198188de12e87643b885efd
+SHA512:
+  metadata.gz: a33b805568f830558b8fa1755794bf476dd14fb9b3153d9dda2ec8009abb89c4cf3758547f43f304b956c46e960c05bbc627ab155ee8b18aef809b14142ce39c
+  data.tar.gz: 0152edaa9a8d096e02be2acabacf97500b9117ac6ce6f310cd218ca1074d8843d75baa5e8f6600e3894efdaf4dbed7a398b627cb222bd4f598050bd5b433f1e1

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--format documentation
+--force-color
+--order rand

data/.rubocop.yml

@@ -0,0 +1,11 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+  TargetRailsVersion: 7.1

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Lavenda Software
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,8 @@
+GEM_TO_PUSH = `ls ucasy*.gem | tail -n 1`
+
+build:
+	gem build ucasy.gemspec
+
+publish:
+	@echo "gem push ${GEM_TO_PUSH}"
+	@gem push ${GEM_TO_PUSH}

data/README.md

@@ -0,0 +1,39 @@
+# Ucasy
+
+Description soon!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ru
+gem "ucasy", "~> 0.0.1"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+bundle add ucasy
+```
+
+## Usage
+
+You can use a Rails generator to create setup files:
+
+```sh
+rails g ucasy:install
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ucasy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/generators/ucasy/install/install_generator.rb

@@ -0,0 +1,23 @@
+module Ucasy
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Generates a application use case base."
+    def create_use_case_base
+      copy_file "use_case_base.rb", use_case_path
+      copy_file ".rspec", Rails.root.join(".rspec")
+    end
+
+    private
+
+    def use_case_path
+      Rails.root.join("app/#{GENERATOR_FOLDER_NAME}/use_case_base.rb")
+    end
+
+    def GENERATOR_FOLDER_NAME
+      return Ucasy::GENERATOR_FOLDER_NAME if defined?(Ucasy::GENERATOR_FOLDER_NAME)
+
+      Ucasy::DEFAULT_GENERATOR_FOLDER_NAME
+    end
+  end
+end

data/lib/generators/ucasy/install/templates/.rspec

@@ -0,0 +1,4 @@
+--require rails_helper
+--format documentation
+--force-color
+--order rand

data/lib/generators/ucasy/install/templates/use_case_base.rb

@@ -0,0 +1,2 @@
+class UseCaseBase < Ucasy::Base
+end

data/lib/ucasy/base.rb

@@ -0,0 +1,61 @@
+require_relative "context"
+require_relative "failure"
+
+module Ucasy
+  class Base
+    class << self
+      def call(context)
+        new(context).perform
+      end
+
+      def required_attributes(*attributes)
+        @required_attributes = attributes
+      end
+
+      def _required_attributes
+        @required_attributes || []
+      end
+    end
+
+    def initialize(context = {})
+      @context = Context.build(context)
+    end
+
+    def perform
+      return if failure?
+
+      validate_context!
+      before if respond_to?(:before)
+      call
+      after if respond_to?(:after)
+
+      self
+    rescue Failure
+      self
+    end
+
+    def call
+      raise StandardError, "You must implement call method"
+    end
+
+    private
+
+    attr_reader :context
+
+    def validate_context!
+      self.class._required_attributes.each do |attribute|
+        next if context.respond_to?(attribute)
+
+        raise ArgumentError, "You must set '#{attribute}' variable"
+      end
+    end
+
+    def method_missing(method_name, *, &block)
+      context.public_send(method_name)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      context.respond_to?(method_name, include_private)
+    end
+  end
+end

data/lib/ucasy/context.rb

@@ -0,0 +1,23 @@
+require "ostruct"
+
+module Ucasy
+  class Context < OpenStruct
+    def self.build(context = {})
+      (self === context) ? context : new(context)
+    end
+
+    def fail!(options = {})
+      options.each { |key, value| self[key.to_sym] = value }
+      @failure = true
+      raise Failure, self
+    end
+
+    def failure?
+      @failure || false
+    end
+
+    def success?
+      !failure?
+    end
+  end
+end

data/lib/ucasy/failure.rb

@@ -0,0 +1,11 @@
+module Ucasy
+  class Failure < StandardError
+    attr_reader :context
+
+    def initialize(context = nil)
+      @context = context
+
+      super
+    end
+  end
+end

data/lib/ucasy/flow.rb

@@ -0,0 +1,22 @@
+module Ucasy
+  class Flow < Base
+    class << self
+      def service_classes(*service_classes)
+        @service_classes = service_classes
+      end
+      alias_method :flow, :service_classes
+
+      def _service_classes
+        @service_classes || []
+      end
+    end
+
+    def call
+      self.class._service_classes.each do |service_class|
+        service_class.call(context)
+      end
+
+      self
+    end
+  end
+end

data/lib/ucasy/version.rb

@@ -0,0 +1,3 @@
+module Ucasy
+  VERSION = "0.0.1"
+end

data/lib/ucasy.rb

@@ -0,0 +1,10 @@
+require_relative "ucasy/version"
+require_relative "ucasy/base"
+require_relative "ucasy/flow"
+
+module Ucasy
+  Ucasy::DEFAULT_GENERATOR_FOLDER_NAME = "use_cases"
+
+  class Error < StandardError
+  end
+end

data/sig/ucasy/spec.rbs

@@ -0,0 +1,4 @@
+module Ucasy
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/ucasy.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/ucasy/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ucasy"
+  spec.version = Ucasy::VERSION
+  spec.authors = ["Lavenda Software"]
+  spec.email = ["lavenda@lavenda.com.br"]
+
+  spec.summary = "Ucasy is just a quick test suite setup for Rails application"
+  spec.homepage = "https://github.com/LavendaSoftware/ucasy"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "#{spec.homepage}/blob/main/README.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/commits/main"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: ucasy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lavenda Software
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-05 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- lavenda@lavenda.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".standard.yml"
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- lib/generators/ucasy/install/install_generator.rb
+- lib/generators/ucasy/install/templates/.rspec
+- lib/generators/ucasy/install/templates/use_case_base.rb
+- lib/ucasy.rb
+- lib/ucasy/base.rb
+- lib/ucasy/context.rb
+- lib/ucasy/failure.rb
+- lib/ucasy/flow.rb
+- lib/ucasy/version.rb
+- sig/ucasy/spec.rbs
+- ucasy.gemspec
+homepage: https://github.com/LavendaSoftware/ucasy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/LavendaSoftware/ucasy
+  source_code_uri: https://github.com/LavendaSoftware/ucasy/blob/main/README.md
+  changelog_uri: https://github.com/LavendaSoftware/ucasy/commits/main
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Ucasy is just a quick test suite setup for Rails application
+test_files: []