rails_services 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5413a8f8f97cf858983bacef0211b5f8c07e4c21
+  data.tar.gz: 5673400b590f441e5a07c6c30673ec5638555149
+SHA512:
+  metadata.gz: c2dbd01c02a5f518be4fa69161b09c9a5be5bc1760434c3602a915fe254130c6e3edec3d0f14c13849f8e9cd45247eaad58a99a551a04cfa3fa9a5d4d42187e1
+  data.tar.gz: c611e5527ee7c2c97223f36a64c5b4ced4ec3bc30d9e3311bf627a63c4da4731c9468c0cca5dc14b50c4feda844663fc004cf6d75e317c446ea7e67a227d1201

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_services.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Craig Kaminsky
+
+MIT License
+
+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,48 @@
+# RailsServices
+
+A very (VERY) simple gem for Rails that adds a generator for easily creating a service class and its accompanying spec file.
+
+At this time, the gem only creates an RSpec test file. MiniTest and Test::Unit support forthcoming. 
+
+## Requirements 
+
+Rails 3.2.19 and higher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_services'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_services
+
+## Usage
+
+Examples: 
+
+    $ rails generate rails_services:create Service Model|Controller Sub-folder [opt]
+    
+    $ rails generate rails_services:destroy Service Model|Controller Sub-folder [opt]
+    
+Sub-folders are optional but, at this time, you may only use one sub-folder. I generally use the sub-folders when I have a naturally grouped set of services.     
+
+## Result
+
+Two files are created:
+
++ app/services/model|controller/[sub-folder]/thing.rb
++ spec/services/model|controller/[sub-folder]/thing_spec.rb
+
+## Contributing
+
+1. Fork it ( https://github.com/imageaid/rails_services/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  exec 'pry -r rails_services -I ./lib'
+end
+

data/lib/generators/rails_services/create/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates a service class and accompanying spec file
+
+Example:
+    rails generate rails_services:create Thing Model|Controller Sub-folder [opt]
+
+    This will create:
+        app/services/model|controller/[sub-folder]/thing.rb
+        spec/services/model|controller/[sub-folder]/thing_spec.rb

data/lib/generators/rails_services/create/create_generator.rb

@@ -0,0 +1,37 @@
+module RailsServices
+  module Generators
+    class CreateGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      argument :service_name, type: :string
+      argument :parent_name, type: :string
+      argument :sub_folder, type: :string, default: ''
+
+      def create_service
+        template 'base_service.rb.erb', "app/services/#{service_directory}/#{service_file}"
+        template 'base_service_spec.rb.erb', "spec/services/#{service_directory}/#{spec_file}"
+      end
+
+      private
+      def service_directory
+        file_path = "#{parent_name.underscore}"
+        file_path += "/#{sub_folder.underscore}" if sub_folder.present?
+        file_path
+      end
+
+      def service_file
+        "#{service_name.underscore}.rb"
+      end
+
+      def spec_file
+        "#{service_name.underscore}_spec.rb"
+      end
+
+      def qualified_name
+        name = "#{parent_name.camelize}::"
+        name += "#{sub_folder.camelize}::" if sub_folder.present?
+        name += "#{service_name.camelize}"
+        name
+      end
+    end
+  end
+end

data/lib/generators/rails_services/create/templates/base_service.rb.erb

@@ -0,0 +1,8 @@
+<%= "class #{qualified_name}" %>
+
+  <%= "# SAMPLE USAGE: #{qualified_name}.call(*args)" %>
+  <%= 'def self.call' %>
+
+  <%= 'end' %>
+
+<%= 'end' %>

data/lib/generators/rails_services/create/templates/base_service_spec.rb.erb

@@ -0,0 +1,11 @@
+<%= "describe #{qualified_name} do" %>
+
+  <%= "context 'doing something' do" %>
+
+    <%= "it 'should test something' do" %>
+      <%= 'skip' %>
+    <%= 'end' %>
+
+  <%= 'end' %>
+
+<%= 'end' %>

data/lib/generators/rails_services/destroy/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Destroys a service class and accompanying spec file
+
+Example:
+    rails generate rails_services:destroy Thing Model|Controller Sub-folder [opt]
+
+    This will remove:
+        app/services/model|controller/[sub-folder]/thing.rb
+        spec/services/model|controller/[sub-folder]/thing_spec.rb

data/lib/generators/rails_services/destroy/destroy_generator.rb

@@ -0,0 +1,51 @@
+module RailsServices
+  module Generators
+    class DestroyGenerator < Rails::Generators::Base
+      argument :service_name, type: :string
+      argument :parent_name, type: :string
+      argument :sub_folder, type: :string, default: ''
+
+      def destroy_service
+        remove_file "app/services/#{full_service_directory}/#{service_file}"
+        remove_file "spec/services/#{full_service_directory}/#{spec_file}"
+
+        manage_containing_directories('app', 'spec')
+      end
+
+      private
+      def full_service_directory
+        file_path = "#{service_parent_directory}"
+        file_path += "/#{sub_folder.underscore}" if sub_folder.present?
+        file_path
+      end
+
+      def service_parent_directory
+        "#{parent_name.underscore}"
+      end
+
+      def service_file
+        "#{service_name.underscore}.rb"
+      end
+
+      def spec_file
+        "#{service_name.underscore}_spec.rb"
+      end
+
+      def manage_containing_directories(*directory_types)
+        directory_types.each do |directory_type|
+          remove_dir("#{directory_type}/services/#{full_service_directory}") if directory_empty?(directory_type)
+          remove_dir("#{directory_type}/services/#{service_parent_directory}") if parent_directory_empty?(directory_type)
+        end
+      end
+
+      def directory_empty?(directory_type)
+        Dir["#{Rails.root}/#{directory_type}/services/#{full_service_directory}/*"].empty?
+      end
+
+      def parent_directory_empty?(directory_type)
+        Dir["#{Rails.root}/#{directory_type}/services/#{service_parent_directory}/*"].empty?
+      end
+
+    end
+  end
+end

data/lib/rails_services.rb

@@ -0,0 +1,10 @@
+require 'rails_services/version'
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+module RailsServices
+  # Your code goes here...
+end

data/lib/rails_services/version.rb

@@ -0,0 +1,3 @@
+module RailsServices
+  VERSION = '1.0.0'
+end

data/rails_services.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_services/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_services'
+  spec.version       = RailsServices::VERSION
+  spec.authors       = ['Craig Kaminsky']
+  spec.email         = ['imageaid@gmail.com']
+  spec.summary       = %q{A Ruby gem that adds a rails generator for creating service classes.}
+  spec.description   = %q{Speed up development when using a Service Layer by easily creating service classes and their attending test (spec) file.}
+  spec.homepage      = 'https://github.com/imageaid/rails_service_generator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 3.2.19'
+  spec.add_dependency 'rails', '>= 3.2.19'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

data/spec/generators/rails_services/create/create_generator_spec.rb

@@ -0,0 +1,5 @@
+describe 'My behaviour' do
+  it 'should do something' do
+    expect(true).to be_falsey
+  end
+end

data/spec/generators/rails_services/destroy/destroy_generator_spec.rb

@@ -0,0 +1,7 @@
+describe 'My behaviour' do
+
+  it 'should do something' do
+    expect(true).to be_falsey
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+require 'rails_services'
+
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: rails_services
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Craig Kaminsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.19
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.19
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: pry
+  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'
+description: Speed up development when using a Service Layer by easily creating service
+  classes and their attending test (spec) file.
+email:
+- imageaid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rails_services/create/USAGE
+- lib/generators/rails_services/create/create_generator.rb
+- lib/generators/rails_services/create/templates/base_service.rb.erb
+- lib/generators/rails_services/create/templates/base_service_spec.rb.erb
+- lib/generators/rails_services/destroy/USAGE
+- lib/generators/rails_services/destroy/destroy_generator.rb
+- lib/rails_services.rb
+- lib/rails_services/version.rb
+- rails_services.gemspec
+- spec/generators/rails_services/create/create_generator_spec.rb
+- spec/generators/rails_services/destroy/destroy_generator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/imageaid/rails_service_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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem that adds a rails generator for creating service classes.
+test_files:
+- spec/generators/rails_services/create/create_generator_spec.rb
+- spec/generators/rails_services/destroy/destroy_generator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: