guard-rspec-graphiti 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e0eb0edfc0087ddfef3091eca921f19d2bd9715a708cea80437ed7205fcd44f
+  data.tar.gz: 903c4fa4a2d132cbe0782ef65071965bf22d1e63fefab25a635891ab3b5d3e73
+SHA512:
+  metadata.gz: c328162ea5ac32ac56ebe0ca2350e3f4e12a2cdaca5246074812bec3085a3262a64959294d299c1c206ac4486f9a52394acb6a3d29eae6047c7aca6406681554
+  data.tar.gz: 843fe31aa1656d2012ee0a2819e67b1706364daa122ccda7e7bf4341d00ecf41cba747a32d71a63d425d3f286cebdf9810c926bb07525f71106d348df11e5e84

data/.gitignore

@@ -0,0 +1,11 @@
+/.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.6

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 guard-rspec-graphiti.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: .
+  specs:
+    guard-rspec-graphiti (1.0.0)
+      graphiti
+      guard-rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    dry-configurable (0.8.2)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.7)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.2)
+    dry-inflector (0.1.2)
+    dry-logic (0.5.0)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (0.15.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.2, >= 0.2.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 0.5, >= 0.5)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    graphiti (1.0.rc.26)
+      activesupport (>= 4.1, < 6)
+      concurrent-ruby (~> 1.0)
+      dry-types (~> 0.13)
+      graphiti_errors (~> 1.0.beta.1)
+      jsonapi-serializable (~> 0.3.0)
+    graphiti_errors (1.0.beta.2)
+      jsonapi-serializable (~> 0.1)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jsonapi-renderer (0.2.0)
+    jsonapi-serializable (0.3.1)
+      jsonapi-renderer (~> 0.2.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.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.2)
+      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)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  guard
+  guard-rspec-graphiti!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/Guardfile

@@ -0,0 +1,17 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Wade Tandy
+
+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,83 @@
+# Guard::Rspec::Graphiti
+
+`guard-rspec-graphiti` is a utility gem for extending the DSL provided by [`guard-rspec`](https://github.com/guard/guard-rspec) to support the new app concepts and test types provided by [Graphiti](https://github.com/graphiti-api/graphiti).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'guard-rspec-graphiti', groups: [:development]
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install guard-rspec-graphiti
+
+## Usage
+
+### Standard Setup
+
+This gem is designed to be used to extend the default guard-rspec template so that changes to your models and
+Graphiti resources will trigger the appropriate resource and API specs. Given a guard-rspec configuration
+block:
+
+```ruby
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+  # ...
+  # remaining setup
+  #
+end
+```
+
+We need to require the graphiti dsl setup the default watchers:
+
+```ruby
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Add everything below this somewhere in your `guard :rspec` block
+  require 'guard/rspec/graphiti/dsl'
+  graphiti = Guard::RSpec::Graphiti::Dsl.new(self, dsl)
+
+  graphiti.watch_resources
+  graphiti.watch_models
+end
+```
+
+And that's it! Now whenever you change `app/models/post.rb`, the specs in
+`spec/resources/post` and `spec/api/posts` will automatically run.
+
+### Custom Watchers
+
+If you have a non-standard setup or wish to add some additional control and watchers, you the dsl also
+exposes some lower-level items to allow you to compose your setup a bit more granularly:
+
+- `graphiti.resources`: A regex to match `app/resources`, with a match group for the resource name
+- `graphiti.resource_specs`: The path to the spec directory for resource specs. Accepts an optional
+  parameter of the resource name, which will only return the directory for the specific resource
+- `graphiti.api_specs`: The path to the spec directory for e2e API specs. Accepts an optional
+  parameter of the resource name, which will only return the directory for the specific API specs
+  for that resource.  Like graphiti, this will default to `specs/api/v1` as the root directory, but
+  if the project has a `.graphiticfg.yml`, it will attempt to replace this with the `namespace`
+  configuration option.
+
+## Development
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/graphiti-api/guard-rspec-graphiti.
+
+## 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,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 "guard/rspec/graphiti"
+
+# 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/guard-rspec-graphiti.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "guard/rspec/graphiti/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-rspec-graphiti"
+  spec.version       = Guard::Rspec::Graphiti::VERSION
+  spec.authors       = ["Wade Tandy"]
+  spec.email         = ["wtandy@bloomberg.net"]
+
+  spec.summary       = "Guard-rspec DSL extensions for Graphiti"
+  spec.description   = "Guard-rspec DSL extensions for Graphiti"
+  spec.homepage      = "https://github.com/graphiti-api/guard-rspec-graphiti"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/graphiti-api/guard-rspec-graphiti"
+  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_dependency 'graphiti'
+  spec.add_dependency 'guard-rspec'
+
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/guard/rspec/graphiti.rb

@@ -0,0 +1,10 @@
+require "guard/compat/plugin"
+require "guard/rspec"
+require "guard/rspec/graphiti/version"
+
+module Guard
+  class RSpec < Plugin
+    module Graphiti
+    end
+  end
+end

data/lib/guard/rspec/graphiti/dsl.rb

@@ -0,0 +1,70 @@
+require_relative '../graphiti'
+
+module Guard
+  class RSpec < Plugin
+    module Graphiti
+      class Dsl
+        def initialize(guard, rspec_dsl)
+          @guard_dsl = guard
+          @rspec_dsl = rspec_dsl
+        end
+
+        def watch_resources
+          @guard_dsl.send(:watch, resources) do |m|
+            [
+              api_specs(m[1]),
+              resource_specs(m[1])
+            ]
+          end
+        end
+
+        def watch_models
+          @guard_dsl.send(:watch, %r{^app/models/(.+)\.rb$}) do |m|
+            [
+              api_specs(m[1]),
+              resource_specs(m[1])
+            ]
+          end
+        end
+
+        def resources
+          %r{^app/resources/(.+)_resource\.rb$}
+        end
+
+        def resource_specs(resource_name = nil)
+          resource_base = "#{rspec.spec_dir}/resources"
+
+          if resource_name
+            "#{resource_base}/#{resource_name.underscore}"
+          else
+            resource_base
+          end
+        end
+
+        def api_specs(resource_name = nil)
+          api_base = "#{rspec.spec_dir}#{api_namespace}"
+
+          if resource_name
+            "#{api_base}/#{resource_name.underscore.pluralize}"
+          else
+            api_base
+          end
+        end
+
+        private
+
+        def rspec
+          @rspec_dsl.rspec
+        end
+
+        def api_namespace
+          graphiti_config['namespace'] || '/api/v1'
+        end
+
+        def graphiti_config
+          @graphiti_config ||= File.exist?(".graphiticfg.yml") ? YAML.load_file(".graphiticfg.yml") : {}
+        end
+      end
+    end
+  end
+end

data/lib/guard/rspec/graphiti/version.rb

@@ -0,0 +1,7 @@
+module Guard
+  module Rspec
+    module Graphiti
+      VERSION = "1.0.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: guard-rspec-graphiti
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Wade Tandy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphiti
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: 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: Guard-rspec DSL extensions for Graphiti
+email:
+- wtandy@bloomberg.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- guard-rspec-graphiti.gemspec
+- lib/guard/rspec/graphiti.rb
+- lib/guard/rspec/graphiti/dsl.rb
+- lib/guard/rspec/graphiti/version.rb
+homepage: https://github.com/graphiti-api/guard-rspec-graphiti
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/graphiti-api/guard-rspec-graphiti
+  source_code_uri: https://github.com/graphiti-api/guard-rspec-graphiti
+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.9
+signing_key: 
+specification_version: 4
+summary: Guard-rspec DSL extensions for Graphiti
+test_files: []