dry-templates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5f950fd00c78faac086b19e1036bdae5453498f4665bb8dd45107bb94ff8695
+  data.tar.gz: 11aea10d2642a8c407c928be7cc5fff72a5664383572a877ae39b5dfb7bbc8a6
+SHA512:
+  metadata.gz: 64c41690845b514dfeaaff3441b47837166b2d420ba462e7aed543e99a317ab715528a4f8b8db7ec2a445feaf0fcf163357edc5d0ed3efb8aa727fcefc4550d9
+  data.tar.gz: 54625e64405ce20b6030e1bf9f48435bf329b0261e7c65a132422de6e5269c416a3a4a1df632451b2cb96d45554d3c40c8a6df71f45e953b75fd56e2f312fc5c

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+tmp
+*.gem
+Gemfile.lock
+.DS_Store
+/.ruby-gemset
+/.ruby-version
+bundle
+.bundle

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2
+script:
+  "bundle exec rspec spec"

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 / 18-01-2019
+
+Initial release.

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 m.chudzik@binarapps.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 dry-templates.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Michał Chudzik
+
+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,80 @@
+# Dry::Templates [![Build Status](https://travis-ci.org/michudzik/dry-templates.svg?branch=master)](https://travis-ci.org/michudzik/dry-templates)
+The purpose of this gem is to add dry-transaction generators to your rails app.
+Generated transactions follow the principle of CRUD, which means that for create, read, update, delete and index actions separate transactions are generated.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry-templates'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dry-templates
+
+## Usage
+Creates transaction for CRUD actions
+
+Example:
+<br/>
+`$ bin/rails generate dry:templates:transactions init`
+
+This will create:
+```
+|- app
+    |- transactions
+        |- application_transaction.rb
+```
+`$ bin/rails generate dry:templates:transactions users`
+
+This will create:
+```
+|- app
+    |- transactions
+        |- application_transaction.rb
+        |- users
+            |- create.rb
+            |- update.rb
+            |- fetch.rb
+            |- destroy.rb
+            |- index.rb
+```
+`$ bin/rails generate dry:templates:transactions users create update`
+
+This will create:
+```
+|- app
+    |- transactions
+        |- application_transaction.rb
+        |- users
+            |- create.rb
+            |- update.rb
+```
+
+### Sample
+https://github.com/michudzik/dry-templates-sample
+Here you can find an example of dry-template generator in action
+
+## 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/michudzik/dry-templates. 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 Dry::Templates project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dry-templates/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 "dry/templates"
+
+# 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/dry-templates.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dry/templates/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dry-templates"
+  spec.version       = Dry::Templates::VERSION
+  spec.authors       = ["Michał Chudzik"]
+  spec.email         = ["m.chudzik@binarapps.com"]
+
+  spec.summary       = %q{A rails generator for dry-transactions.}
+  spec.description   = %q{This generator will create crud resource transactions so as to free up the developer from setting up boilerplate for them}
+  spec.homepage      = "https://github.com/michudzik/dry-templates"
+  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.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  # 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"
+  spec.add_development_dependency "rails", "~> 5.0"
+  spec.add_development_dependency 'ammeter'
+  spec.add_development_dependency 'sqlite3', '>= 1'
+end

data/lib/dry/templates.rb

@@ -0,0 +1,7 @@
+require "dry/templates/version"
+require "dry/templates/generators/transactions/transactions_generator"
+
+module Dry
+  module Templates
+  end
+end

data/lib/dry/templates/generators/transactions/USAGE

@@ -0,0 +1,33 @@
+Description:
+  Creates transaction for CRUD actions
+
+Example:
+  $ bin/rails generate dry:templates:transactions init
+
+  This will create:
+    |- app
+      |- transactions
+        |- application_transaction.rb
+
+  $ bin/rails generate dry:templates:transactions users
+
+  This will create:
+    |- app
+      |- transactions
+        |- application_transaction.rb
+        |- users
+          |- create.rb
+          |- update.rb
+          |- fetch.rb
+          |- destroy.rb
+          |- index.rb
+
+  $ bin/rails generate dry:templates:transactions users create update
+
+  This will create:
+    |- app
+      |- transactions
+        |- application_transaction.rb
+        |- users
+          |- create.rb
+          |- update.rb

data/lib/dry/templates/generators/transactions/templates/exec/application_transaction.template

@@ -0,0 +1,3 @@
+class ApplicationTransaction
+  include Dry::Transaction
+end

data/lib/dry/templates/generators/transactions/templates/exec/create_transaction.template

@@ -0,0 +1,19 @@
+module <%= model.pluralize.camelcase %>
+  class Create < ApplicationTransaction
+    try :build, catch: ActiveRecord::UnknownAttributeError
+    check :validate
+    try :save, catch: ActiveRecord::RecordInvalid
+
+    def build(params)
+      <%= model.singularize.camelcase %>.new(params)
+    end
+
+    def validate(record)
+      record.valid?
+    end
+
+    def save(record)
+      record.save!
+    end
+  end
+end

data/lib/dry/templates/generators/transactions/templates/exec/destroy_transaction.template

@@ -0,0 +1,14 @@
+module <%=  model.pluralize.camelcase %>
+  class Destroy < ApplicationTransaction
+    try :find, catch: ActiveRecord::RecordNotFound
+    try :delete, catch: ActiveRecord::RecordNotDestroyed
+
+    def find(id)
+      <%= model.singularize.camelcase %>.find(id)
+    end
+
+    def delete(record)
+      record.destroy!
+    end
+  end
+end

data/lib/dry/templates/generators/transactions/templates/exec/fetch_transaction.template

@@ -0,0 +1,11 @@
+module <%= model.pluralize.camelcase %>
+  class Fetch < ApplicationTransaction
+    try :find, catch: ActiveRecord::RecordNotFound
+
+    private
+
+    def find(id)
+      <%= model.singularize.camelcase %>.find(id)
+    end
+  end
+end

data/lib/dry/templates/generators/transactions/templates/exec/index_transaction.template

@@ -0,0 +1,11 @@
+module <%= model.pluralize.camelcase %>
+  class Index < ApplicationTransaction
+    try :fetch_all_<%= model.pluralize.underscore %>, catch: ActiveRecord::ActiveRecordError
+
+    private
+
+    def fetch_all_<%= model.pluralize.underscore %>
+      <%= model.singularize.camelcase %>.all
+    end
+  end
+end

data/lib/dry/templates/generators/transactions/templates/exec/update_transaction.template

@@ -0,0 +1,25 @@
+module <%= model.pluralize.camelcase %>
+  class Update < ApplicationTransaction
+    try :find, catch: ActiveRecord::RecordNotFound
+    map :update_attributes
+    check :validate
+    try :save, catch: ActiveRecord::RecordInvalid
+
+    def find(params)
+      { record: <%= model.singularize.camelcase %>.find(params[:id]), attributes: params.except(:id) }
+    end
+
+    def update_attributes(params)
+      params[:record].assign_attributes(params[:attributes])
+      params[:record]
+    end
+
+    def validate(record)
+      record.valid?
+    end
+
+    def save(record)
+      record.save!
+    end
+  end
+end

data/lib/dry/templates/generators/transactions/transactions_generator.rb

@@ -0,0 +1,61 @@
+require 'rails/generators'
+
+module Dry
+  module Templates
+    module Generators
+      class TransactionsGenerator < Rails::Generators::Base
+        source_root File.expand_path('templates', __dir__)
+        argument :model, type: :string, optional: true
+        argument :operations, type: :array, optional: true, default: ['create', 'update', 'destroy', 'fetch', 'index']
+
+        def initializer
+          generate_application_transaction_file
+        end
+
+        def generate_transactions
+          return unless model.present? && model != 'init'
+
+          generate_create_transaction if operations.include?('create')
+          generate_update_transaction if operations.include?('update')
+          generate_destroy_transaction if operations.include?('destroy')
+          generate_fetch_transaction if operations.include?('fetch')
+          generate_index_transaction if operations.include?('index')
+        end
+
+        private
+
+        def generate_application_transaction_file
+          copy_file 'exec/application_transaction.template', 'app/transactions/application_transaction.rb'
+        end
+
+        def generate_create_transaction
+          template 'exec/create_transaction.template', "#{construct_relative_path_to_exec}create.rb"
+        end
+
+        def generate_update_transaction
+          template 'exec/update_transaction.template', "#{construct_relative_path_to_exec}update.rb"
+        end
+
+        def generate_destroy_transaction
+          template 'exec/destroy_transaction.template', "#{construct_relative_path_to_exec}destroy.rb"
+        end
+
+        def generate_fetch_transaction
+          template 'exec/fetch_transaction.template', "#{construct_relative_path_to_exec}fetch.rb"
+        end
+
+        def generate_index_transaction
+          template 'exec/index_transaction.template', "#{construct_relative_path_to_exec}index.rb"
+        end
+
+        def construct_relative_path_to_exec
+          "app/transactions/#{model.pluralize.underscore}/"
+        end
+
+        def construct_relative_path_to_spec
+          "spec/transactions/#{model.pluralize.underscore}/"
+        end
+      end
+    end
+  end
+end

data/lib/dry/templates/version.rb

@@ -0,0 +1,5 @@
+module Dry
+  module Templates
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: dry-templates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michał Chudzik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-29 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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description: This generator will create crud resource transactions so as to free up
+  the developer from setting up boilerplate for them
+email:
+- m.chudzik@binarapps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dry-templates.gemspec
+- lib/dry/templates.rb
+- lib/dry/templates/generators/transactions/USAGE
+- lib/dry/templates/generators/transactions/templates/exec/application_transaction.template
+- lib/dry/templates/generators/transactions/templates/exec/create_transaction.template
+- lib/dry/templates/generators/transactions/templates/exec/destroy_transaction.template
+- lib/dry/templates/generators/transactions/templates/exec/fetch_transaction.template
+- lib/dry/templates/generators/transactions/templates/exec/index_transaction.template
+- lib/dry/templates/generators/transactions/templates/exec/update_transaction.template
+- lib/dry/templates/generators/transactions/transactions_generator.rb
+- lib/dry/templates/version.rb
+homepage: https://github.com/michudzik/dry-templates
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A rails generator for dry-transactions.
+test_files: []