cuprite-downloads 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bef81779b6915300ccf8f2b3074109e4751fca2d32a41615b1a778ddb2e56bc2
+  data.tar.gz: e330311c003c579d1b03cb398e019bda11129c62637719cd1e6b05370d00b3bb
+SHA512:
+  metadata.gz: 5b2a412dc1088560c1db3b01b24d2f5fce576ecd4a1f9b6eb03ec4464a343a71cbaedd7a798be0d43fc04fb72e431a4baf49f8e22d2f1da121086ebc26296f8c
+  data.tar.gz: e883cf893cfc75419c8a88eee92c774960d2f341d058ed38f81e708adb9fe8d8db2a8c459a9c9006126313df0ef5997d75d486df25b3902bc275b4f9a947c779

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

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/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cuprite-downloads.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    cuprite-downloads (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  cuprite-downloads!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Micah Geisel
+
+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,44 @@
+# Cuprite::Downloads
+
+A file download API for Cuprite
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+gem 'cuprite-downloads'
+```
+
+```ruby
+# features/support/env.rb
+require "capybara/cuprite"
+require "cuprite/downloads/cucumber"
+```
+
+_TODO: other test runner integration_
+
+This gem adds a `page.driver.downloads` method, which returns an instance of `Capybara::Cuprite::Downloads`. This object has a few useful methods:
+
+* `#filenames`: an array of all the downloaded filenames
+* `#[](filename)`: an open File handle to the specified filename
+
+These methods also exist, but are mostly only useful in hooking it up to Capybara and your test runner, which is taken care of in the `cuprite/downloads/cucumber` file
+
+* `#pathname`: The directory where the downloads are saved, usualy something like `tmp/capybara/1640698858474/downloads`. The number is a unique key to ensure concurrent file downloads don't collide.
+* `#reset`: Empties the directory above. This is automatically called after each cucumber scenario
+
+## 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 the created tag, 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]/cuprite-downloads.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "cuprite/downloads"
+
+# 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/cuprite-downloads.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/cuprite/downloads/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cuprite-downloads"
+  spec.version       = Cuprite::Downloads::VERSION
+  spec.authors       = ["Micah Geisel"]
+  spec.email         = ["micah@botandrose.com"]
+
+  spec.summary       = "Adds file download capabilities to Cuprite"
+  spec.homepage      = "https://github.com/botandrose/cuprite-downloads"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/cuprite/downloads/cucumber.rb

@@ -0,0 +1,17 @@
+require "cuprite/downloads"
+require "capybara/cuprite/driver"
+
+Capybara::Cuprite::Driver.class_eval do
+  def downloads
+    @downloads ||= Capybara::Cuprite::Downloads.new
+  end
+end
+
+Capybara.save_path = Capybara::Cuprite::Downloads.pathname
+
+Before do
+  if downloads = page.driver.try(:downloads)
+    downloads.reset
+  end
+end
+

data/lib/cuprite/downloads/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cuprite
+  module Downloads
+    VERSION = "0.1.0"
+  end
+end

data/lib/cuprite/downloads.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "capybara"
+
+module Capybara
+  module Cuprite
+    class Downloads
+      class NotFound < Capybara::ExpectationNotMet; end
+
+      def self.pathname
+        @pathname ||= begin
+          unique_id = Time.now.strftime('%s%L') # to keep concurrent runs from colliding
+          Capybara.save_path.join(unique_id, "downloads")
+       end
+      end
+
+      def pathname
+        self.class.pathname
+      end
+
+      def dir
+        pathname.to_s
+      end
+
+      def reset
+        FileUtils.rm_rf(dir)
+        FileUtils.mkdir_p(dir)
+      end
+
+      def filenames
+        pathname.entries.reject(&:directory?).map(&:to_s)
+      end
+
+      def [] filename
+        Capybara.current_session.document.synchronize do
+          begin
+            File.open(pathname.join(filename))
+          rescue Errno::ENOENT
+            raise NotFound.new("Couldn't find #{filename} in #{filenames}")
+          end
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: cuprite-downloads
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Micah Geisel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-28 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- micah@botandrose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cuprite-downloads.gemspec
+- lib/cuprite/downloads.rb
+- lib/cuprite/downloads/cucumber.rb
+- lib/cuprite/downloads/version.rb
+homepage: https://github.com/botandrose/cuprite-downloads
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/botandrose/cuprite-downloads
+  source_code_uri: https://github.com/botandrose/cuprite-downloads
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Adds file download capabilities to Cuprite
+test_files: []