stitches 3.7.3 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fa18e703222c9f9f2cc2b750cbf06a1bf9ddac8d473e6c2775d3d0cd840e59e
-  data.tar.gz: 550563efbfc95a84ff7c9375cbd4cd6d45eff8621370780f90760ddecc4afa3e
+  metadata.gz: f22af42820e6175c739a77f2f6945dd3d6aea8f94b43509303ed27874e315ca4
+  data.tar.gz: fee8fce193a17741483531c884cd20638ad92e1b5ce423a0673d85ee467aa5f3
 SHA512:
-  metadata.gz: 0d81db63050704736cc9aaaebc3ccc0f06bcb271a36b734c195f9b5298121c18fd43c529e32ec2ba2dcf2e76c8dda411fc245d8229a4a2df21889de87dded7d7
-  data.tar.gz: cd636756307dd9395860278f80f9fea1638ceef28105d91cc319c80db74de58809e7e6e396f1e706b123705c7905a46d0a5e3655c7c84cd077fe6eab9808c577
+  metadata.gz: 24c0456e68046e5a7a3d9cd045f35fe3095659a25da0e77b5d623ff64c759893a5c46a9367c898d58287312a29b85a186613cdaeda09558036ffa698d2e68fd1
+  data.tar.gz: e019d85dd736bf28b5e751ffef132cae093019877f6c5aa743e0a39f4b51e1d7da37051aa8ee9ad799db13d27fd24d8cfb1df7b8472ba2491c198ac8cdc0f27c

data/.circleci/config.yml

@@ -8,6 +8,7 @@ jobs:
     - image: circleci/ruby:2.6.3
     steps:
     - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run:
         name: Artifactory login
@@ -24,6 +25,7 @@ jobs:
     working_directory: "~/stitches"
     steps:
     - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
@@ -45,6 +47,7 @@ jobs:
     working_directory: "~/stitches"
     steps:
     - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
@@ -66,6 +69,7 @@ jobs:
     working_directory: "~/stitches"
     steps:
     - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
@@ -87,6 +91,7 @@ jobs:
     working_directory: "~/stitches"
     steps:
     - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc

data/.gitignore

@@ -9,4 +9,5 @@ config/database.yml
 .jhw-cache
 **.orig
 Gemfile.lock
+Gemfile.*.lock
 .projections.json

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.6.3

data/PULL_REQUEST_TEMPLATE.md

@@ -5,17 +5,3 @@
 ## Solution
 
 «Brief description of how you solved the problem»
-
-## Checklist
-
-### Before Merging
-
-- [ ] If there is an RC on this branch, revert the version change in `version.rb`
-
-### After Merging
-
-See the [gem release process](https://github.com/stitchfix/eng-wiki/blob/master/technical-topics/updating-gem-versions.md) for a detailed list, but the gist of it is:
-
-- [ ] Fetch `master` locally and run the applicable `rake version:*` task **on `master`** to bump the version
-- [ ] Run `rake release` **on `master`** to release the new version on Gemfury
-- [ ] Add [release notes](https://github.com/stitchfix/messaging/releases) - **this is very important in helping other engineers understand what changed in the new version**

data/README.md

@@ -29,8 +29,6 @@ bundle install
 Then, set it up:
 
 ```
-> bin/rails generate rspec:install
-> bin/rails generate apitome:install
 > bin/rails generate stitches:api
 > bundle exec rake db:migrate
 ```

data/lib/stitches.rb

@@ -1,4 +1,2 @@
 require 'stitches_norailtie'
 require 'stitches/railtie'
-# Add new stitches ruby files to the stitches_norailtie file instead of here
-require 'apitome'

data/lib/stitches/api_generator.rb

@@ -4,7 +4,7 @@ module Stitches
   class ApiGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    source_root(File.expand_path(File.join(File.dirname(__FILE__),"generator_files")))
+    source_root(File.expand_path(File.join(File.dirname(__FILE__), "generator_files")))
 
     def self.next_migration_number(path)
       Time.now.utc.strftime("%Y%m%d%H%M%S")
@@ -12,14 +12,21 @@ module Stitches
 
     desc "Bootstraps your API service with a basic ping controller and spec to ensure everything is setup properly"
     def bootstrap_api
-      inject_into_file "Gemfile", after: /^gem ['"]rails['"].*$/ do<<-GEM
-
-gem "apitome"
-gem "responders"
-gem "rspec_api_documentation", group: [ :development, :test ]
-gem "capybara", group: [ :development, :test ]
-      GEM
+      gem "stitches"
+      gem "apitome"
+      gem_group :development, :test do
+        gem "rspec"
+        gem "rspec-rails"
+        gem "rspec_api_documentation"
       end
+
+      run "bundle install"
+      generate "apitome:install"
+      generate "rspec:install"
+
+      gsub_file 'config/initializers/apitome.rb', /config.mount_at = .*$/, "config.mount_at = nil"
+      gsub_file 'config/initializers/apitome.rb', /config.title = .*$/, "config.title = 'Service Documentation'"
+
       inject_into_file "config/routes.rb", before: /^end/ do<<-ROUTES
 namespace :api do
   scope module: :v1, constraints: Stitches::ApiVersionConstraint.new(1) do
@@ -32,15 +39,14 @@ namespace :api do
     # as well as for your client to be able to validate this as well.
   end
 end
-api_docs = Rack::Auth::Basic.new(Apitome::Engine ) do |_,password|
+
+api_docs = Rack::Auth::Basic.new(Apitome::Engine) do |_, password|
   password == ENV['HTTP_AUTH_PASSWORD']
 end
 mount api_docs, at: "docs"
       ROUTES
       end
 
-      run 'bundle install'
-
       copy_file "app/controllers/api.rb"
       copy_file "app/controllers/api/api_controller.rb"
       copy_file "app/controllers/api/v1.rb"
@@ -53,8 +59,6 @@ mount api_docs, at: "docs"
       template "spec/features/api_spec.rb.erb", "spec/features/api_spec.rb"
       copy_file "spec/acceptance/ping_v1_spec.rb", "spec/acceptance/ping_v1_spec.rb"
 
-      run 'bundle install'
-
       migration_template "db/migrate/enable_uuid_ossp_extension.rb", "db/migrate/enable_uuid_ossp_extension.rb"
       sleep 1 # allow clock to tick so we get different numbers
       migration_template "db/migrate/create_api_clients.rb", "db/migrate/create_api_clients.rb"
@@ -70,26 +74,23 @@ require 'stitches/spec'
 
       append_to_file 'spec/rails_helper.rb' do<<-RSPEC_API
 require 'rspec_api_documentation'
+
 RspecApiDocumentation.configure do |config|
-config.format = :json
-config.request_headers_to_include = %w(
-  Accept
-  Content-Type
-  Authorization
-  If-Modified-Since
-)
-config.response_headers_to_include = %w(
-  Last-Modified
-  ETag
-)
-config.api_name = "YOUR SERVICE NAME HERE"
+  config.format = :json
+  config.request_headers_to_include = %w(
+    Accept
+    Content-Type
+    Authorization
+    If-Modified-Since
+  )
+  config.response_headers_to_include = %w(
+    Last-Modified
+    ETag
+  )
+  config.api_name = "YOUR SERVICE NAME HERE"
 end
-      RSPEC_API
+RSPEC_API
       end
-      run "rails g apitome:install"
-      gsub_file 'config/initializers/apitome.rb', /config.mount_at = .*$/, "config.mount_at = nil"
-      gsub_file 'config/initializers/apitome.rb', /config.title = .*$/, "config.title = 'Service Documentation'"
-
     end
   end
 end

data/lib/stitches/version.rb

@@ -1,3 +1,3 @@
 module Stitches
-  VERSION = '3.7.3'
+  VERSION = '3.8.0'
 end

data/spec/integration/add_to_rails_app_spec.rb

@@ -5,9 +5,10 @@ require "open3"
 RSpec.describe "Adding Stitches to a New Rails App", :integration do
   let(:work_dir) { Dir.mktmpdir }
   let(:rails_app_name) { "swamp-thing" }
+  let(:rails_root) { Pathname(work_dir) / rails_app_name }
 
   def run(command)
-    stdout, stderr, stat = Open3.capture3(command)
+    stdout, stderr, stat = Open3.capture3({ 'BUNDLE_GEMFILE' => rails_root.join('Gemfile').to_path }, command)
     success = stat.success? && stdout !~ /Could not find generator/im
 
     if ENV["DEBUG"] == 'true' || !success
@@ -37,21 +38,30 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
       "--no-rc",
       "--skip-bundle",
     ].join(" ")
-    FileUtils.chdir work_dir do
-      run rails_new
-      FileUtils.chdir rails_app_name do
-        example.run
+
+    # Use this local version of stitches rather than the one on Rubygems
+    gem_path = File.expand_path("../..", File.dirname(__FILE__))
+    use_local_stitches = %{echo "gem 'stitches', path: '#{gem_path}'" >> Gemfile}
+
+    Bundler.with_clean_env do
+      FileUtils.chdir work_dir do
+        run rails_new
+
+        FileUtils.chdir rails_app_name do
+          run use_local_stitches
+          # It's unclear why, but on CI the gems are not found when installed
+          # through bundler however installing them explicitly first fixes it.
+          run "gem install apitome rspec-rails rspec_api_documentation"
+          run "bundle install"
+          example.run
+        end
       end
     end
   end
 
   it "works as described in the README" do
-    run "bin/rails generate rspec:install"
-    run "bin/rails generate apitome:install"
     run "bin/rails generate stitches:api"
 
-    rails_root = Pathname(work_dir) / rails_app_name
-
     # Yuck!  So much duplication!  BUT: Rails app templates have a notoriously silent failure mode, so mostly
     # what this is doing is ensuring that the generator inserted stuff when asked and that the very basics of what happens 
     # during generation are there.  It's gross, and I'm sorry.
@@ -60,9 +70,7 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
     aggregate_failures do
       expect(File.exist?(rails_root / "app" / "controllers" / "api" / "api_controller.rb")).to eq(true)
       expect(rails_root / "Gemfile").to contain_gem("apitome")
-      expect(rails_root / "Gemfile").to contain_gem("responders")
       expect(rails_root / "Gemfile").to contain_gem("rspec_api_documentation")
-      expect(rails_root / "Gemfile").to contain_gem("capybara")
       expect(rails_root / "config" / "routes.rb").to have_route(namespace: :api, module_scope: :v1, resource: 'ping')
       expect(rails_root / "config" / "routes.rb").to have_route(namespace: :api, module_scope: :v2, resource: 'ping')
       expect(rails_root / "config" / "routes.rb").to have_mounted_engine("Apitome::Engine")
@@ -81,11 +89,7 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
   end
 
   it "inserts the deprecation module into ApiController" do
-    run "bin/rails generate rspec:install"
-    run "bin/rails generate apitome:install"
     run "bin/rails generate stitches:api"
-
-    rails_root = Pathname(work_dir) / rails_app_name
     api_controller = rails_root / "app" / "controllers" / "api" / "api_controller.rb"
 
     api_controller_contents = File.read(api_controller).split(/\n/)
@@ -106,11 +110,8 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
   end
 
   it "inserts can update old configuration" do
-    run "bin/rails generate rspec:install"
-    run "bin/rails generate apitome:install"
     run "bin/rails generate stitches:api"
 
-    rails_root = Pathname(work_dir) / rails_app_name
     initializer = rails_root / "config" / "initializers" / "stitches.rb"
 
     initializer_contents = File.read(initializer).split(/\n/)

data/stitches.gemspec

@@ -20,10 +20,8 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency("rails")
   s.add_runtime_dependency("pg")
-  s.add_runtime_dependency("rspec", ">= 3")
-  s.add_runtime_dependency("rspec-rails", "~> 3")
-  s.add_runtime_dependency("apitome")
 
+  s.add_development_dependency("rspec", ">= 3")
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec_junit_formatter")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stitches
 version: !ruby/object:Gem::Version
-  version: 3.7.3
+  version: 3.8.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,41 +48,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: apitome
-  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -212,8 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: You'll be in stitches at how easy it is to create a service at Stitch Fix