rails-api-controller-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c60153b3662893d2e8cb623f9d7583eace4b111a2427969a0c43976af29852d5
+  data.tar.gz: 70242e543f545a2102a36b3e13318597750041c53ab9574ef822a2c3300a5a73
+SHA512:
+  metadata.gz: faa8ea87ea623ab0c39083551c57072904332d6dbe94dd884e3db932437d998fcb679f475e0cb27f3e96cbc733179cd8259d68f861c9d3062ecdc2c5cbbc6f67
+  data.tar.gz: 2ebd0864d34297545245404f7ef777fe48dad931d6e60966e5a5735f1c3b4e8e3e6dd01c0e26b50f2e434512e12ed912f61d3f9f87c158055e7546709f81052d

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at przemyslaw.piotrowski@atteo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails-api-controller-generator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    rails-api-controller-generator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rails-api-controller-generator!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 thmyrk
+
+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/README.md

@@ -0,0 +1,59 @@
+# rails-api-controller-generator
+
+## Description
+This generator is here to speed up the process of you writing boilercode for your rest-api Rails app.
+
+This generator is highly opinionated. It creates files that fit the way I manage my files and directories inside a Rails project. Also, it assumes you are using: `rspec`, `dry-validation`, *use cases pattern* and *presenter pattern*.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-api-controller-generator'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In your project root folder execute:
+
+    $ bundle exec rails generate api_controller model_name action1 action2
+
+So for example running:
+
+    $ bundle exec rails generate api_controller post index create
+
+will create following files:
+* app/controllers/api/v1/posts_controller.rb                                                                                 
+* app/schemas/posts_index_schema.rb                                                                            
+* app/use_cases/posts/index.rb                                                                                 
+* app/schemas/posts_create_schema.rb                                                                            
+* app/use_cases/posts/create.rb                                                                                 
+* app/presenters/post_presenter.rb                                                                               
+* app/presenters/posts_presenter.rb                                                                              
+* spec/requests/posts_spec.rb
+
+Each of these files will be filled with code.
+Model name needs to be singular!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails-api-controller-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the rails-api-controller-generator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails-api-controller-generator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/api/controller/generator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/api_controller/api_controller_generator.rb

@@ -0,0 +1,16 @@
+class ApiControllerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :actions, type: :array, default: []
+
+  def generate_api_controller
+    template "controller.rb", "app/controllers/api/v1/#{plural_name}_controller.rb"
+    actions.each do |action|
+      @action = action
+      template "schema.rb", "app/schemas/#{plural_name}_#{action}_schema.rb"
+      template "use_case.rb", "app/use_cases/#{plural_name}/#{action}.rb"
+    end
+    template "presenter.rb", "app/presenters/#{singular_name}_presenter.rb"
+    template "array_presenter.rb", "app/presenters/#{plural_name}_presenter.rb"
+    template "spec.rb", "spec/requests/#{plural_name}_spec.rb"
+  end
+end

data/lib/generators/api_controller/templates/array_presenter.rb

@@ -0,0 +1,11 @@
+class <%= class_name.pluralize %>Presenter < BasePresenter
+  def initialize(<%= plural_name %>)
+    @<%= plural_name %> = <%= plural_name %>
+  end
+
+  def build_many(*representations, **keyword_representations)
+    @<%= plural_name %>.map do |exercise|
+      <%= class_name %>Presenter.new(exercise).build(*representations, keyword_representations)
+    end
+  end
+end

data/lib/generators/api_controller/templates/controller.rb

@@ -0,0 +1,18 @@
+module Api
+  module V1
+    class <%= class_name.pluralize %>Controller < ApiController
+<% for action in actions %>
+      def <%= action %>
+        validate_params!(<%= class_name.pluralize %><%= action.classify %>Schema::Schema)
+        UseCases::<%= class_name.pluralize %>::<%= action.classify %>.new(<%= plural_name %>_<%= action %>_params).call
+        render_ok
+      end
+<% end %>
+      private
+
+      def <%= plural_name %>_<%= action %>_params
+        params.permit(:id)
+      end
+    end
+  end
+end

data/lib/generators/api_controller/templates/presenter.rb

@@ -0,0 +1,14 @@
+class <%= class_name %>Presenter < BasePresenter
+  def initialize(<%= singular_name %>)
+    @<%= singular_name %> = <%= singular_name %>
+  end
+
+  def basic
+    <%= singular_name %> = {}
+    <%= singular_name %>[:id] = @<%= singular_name %>.id
+    # TODO: fill in presenter
+    <%= singular_name %>[:created_at] = @<%= singular_name %>.created_at
+    <%= singular_name %>[:updated_at] = @<%= singular_name %>.updated_at
+    <%= singular_name %>
+  end
+end

data/lib/generators/api_controller/templates/schema.rb

@@ -0,0 +1,6 @@
+class <%= class_name.pluralize %><%= @action.classify %>Schema
+  Schema = Dry::Validation.Params(BaseSchema) do
+    # TODO: fill in schema. Example rule:
+    # required(:name).filled(:str?).value(min_size?: 2)
+  end
+end

data/lib/generators/api_controller/templates/spec.rb

@@ -0,0 +1,49 @@
+require "rails_helper"
+
+RSpec.describe "<%= class_name.pluralize %> API" do
+  let(:parsed_response) do
+    JSON.parse(response.body)
+  end
+
+  RSpec.shared_examples "<%= plural_name %> invalid parameter format" do |parameter_name, incorrect_value|
+    let(:request_params) { super().merge({ parameter_name => incorrect_value }) }
+    it do
+      subject
+      expect(response).to have_http_status(400)
+    end
+    it { expect { subject }.to change { <%= class_name %>.count }.by(0) }
+    it do
+      subject
+      expect(parsed_response).to include("errors")
+    end
+  end
+<% for action in actions %>
+  context "GET #<%= action %>" do
+    let(:name) { "Breakfast" }
+    let(:request_params) do
+      {
+        name: name
+      }
+    end
+    subject { get "/api/v1/<%= plural_name %>", params: request_params }
+
+    describe "param validation" do
+      # TODO: fill in param validation, examples:
+      # it_behaves_like "<%= plural_name %> invalid parameter format", :name, ""
+      # it_behaves_like "<%= plural_name %> invalid parameter format", :name, nil
+    end
+
+    describe "response" do
+      before { subject }
+      it { expect(response).to have_http_status(200) }
+      it { expect(parsed_response).to be_empty }
+    end
+
+    it do
+      subject
+      expect(response).to have_http_status(200)
+    end
+    it { expect { subject }.to change { <%= class_name %>.count }.by(1) }
+  end
+<% end %>
+end

data/lib/generators/api_controller/templates/use_case.rb

@@ -0,0 +1,13 @@
+module UseCases
+  module <%= class_name.pluralize %>
+    class <%= @action.classify %>
+      def initialize(params)
+        @params = params
+      end
+
+      def call
+        # TODO: fill in logic
+      end
+    end
+  end
+end

data/lib/rails/api/controller/generator.rb

@@ -0,0 +1,11 @@
+require "rails/api/controller/generator/version"
+
+module Rails
+  module Api
+    module Controller
+      module Generator
+        # Your code goes here...
+      end
+    end
+  end
+end

data/lib/rails/api/controller/generator/version.rb

@@ -0,0 +1,9 @@
+module Rails
+  module Api
+    module Controller
+      module Generator
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/rails-api-controller-generator.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails/api/controller/generator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-api-controller-generator"
+  spec.version       = "0.1.0"
+  spec.authors       = ["thmyrk"]
+  spec.email         = ["przemyslaw.piotrowski@atteo.com"]
+
+  spec.summary       = "Proper rails generator for controller in REST API using RSpec and use_case pattern"
+  spec.description   = "Generates: controller file with actions specified in arguments, schema file for param validation written using dry-validation"\
+                       "gem, use case class for handling logic of the request, presenter class for serialization of objects, request rspec specs for"\
+                       "proper testing"
+  spec.homepage      = "https://github.com/thmyrk/rails-api-controller-generator"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rails-api-controller-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- thmyrk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Generates: controller file with actions specified in arguments, schema
+  file for param validation written using dry-validationgem, use case class for handling
+  logic of the request, presenter class for serialization of objects, request rspec
+  specs forproper testing'
+email:
+- przemyslaw.piotrowski@atteo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/api_controller/api_controller_generator.rb
+- lib/generators/api_controller/templates/array_presenter.rb
+- lib/generators/api_controller/templates/controller.rb
+- lib/generators/api_controller/templates/presenter.rb
+- lib/generators/api_controller/templates/schema.rb
+- lib/generators/api_controller/templates/spec.rb
+- lib/generators/api_controller/templates/use_case.rb
+- lib/rails/api/controller/generator.rb
+- lib/rails/api/controller/generator/version.rb
+- rails-api-controller-generator.gemspec
+homepage: https://github.com/thmyrk/rails-api-controller-generator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Proper rails generator for controller in REST API using RSpec and use_case
+  pattern
+test_files: []