specs_to_readme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abaead4d905d8c6792bf5bece30cc1e0d9b7a4b96e6227a6dfb3e5933ea14088
+  data.tar.gz: 63e7db7580c2580593b2f2f0ce075a2033d59d3b5b2cc2c3f5c0356bbd94dac4
+SHA512:
+  metadata.gz: 96cce4e22c3196f0ab076e526c378801ba302d718bc56e0ebc95d85b87eca990b9b866942ee3fb1c0613f9fab3ce6c9c81999e9fcbbade9174a17c2c0aca861c
+  data.tar.gz: 9a2a5657ffab6988de6b8b038933a7b2652c68ca6d0d79f586335c6c83b8dbf49bef437617272bd97eb60fcc979d9e007fc344569265ea89839fe08a43cbc007

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,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.5
+before_install: gem install bundler -v 2.1.4

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 jelani@firstdraft.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in specs_to_readme.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jelani Woods
+
+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,45 @@
+# SpecsToReadme
+
+
+## Installation
+
+Add this line to your application's `Gemfile` in the development group:
+
+```ruby
+gem "specs_to_readme"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install specs_to_readme
+
+## Usage
+
+Run
+
+```bash
+rake specs:readme
+```
+
+## 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/firstdraft/specs_to_readme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/firstdraft/specs_to_readme/blob/main/CODE_OF_CONDUCT.md).
+
+
+## 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 SpecsToReadme project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/firstdraft/specs_to_readme/blob/main/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 "specs_to_readme"
+
+# 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/lib/specs_to_readme/Rakefile

@@ -0,0 +1,4 @@
+require 'specs_to_readme'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/specs_to_readme/railite.rb

@@ -0,0 +1,13 @@
+require 'specs_to_readme'
+require 'rails'
+
+module SpecsToReadme
+  class Railtie < Rails::Railtie
+    railtie_name :specs_to_readme
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/specs_to_readme/tasks/specs/readme.rake

@@ -0,0 +1,35 @@
+namespace :specs do
+  desc "Adds rspec test descriptions to list in README."
+  task :readme do
+    `bundle exec rspec --order default --require spec_helper --format documentation --no-color --out specs.md`
+    specs = File.open("specs.md").read
+    
+    last_line = specs.split("\n").last
+    
+    if last_line.include?("0 failures")
+      new_spec_content = specs.gsub(/($\n\s\s)/, " ")
+      new_spec_content = new_spec_content.gsub(/^Finished.*\n.*/, "")
+      new_spec_content = new_spec_content.gsub(/^(?!\n)/, "<li>")
+      new_spec_content = new_spec_content.gsub(/.$/, "</li>")
+    else
+      new_spec_content = specs.gsub(/Failures:(.|\n)*/, "").gsub(/\(FAILED - \d+\)/, "</li>")
+      new_spec_content = new_spec_content.gsub(/$\n^\s\s/, " ")
+      new_spec_content = new_spec_content.gsub(/^(?!\n)/, "<li>")
+    end
+    
+    top = <<~HEREDOC
+    <details>
+      <summary>Click here to see names of each test</summary>
+    HEREDOC
+    readme = File.open("README.md", "a")
+    readme.write("\n")
+    readme.write("## Specs")
+    readme.write("\n")
+    readme.write(top)
+    readme.write(new_spec_content)
+    readme.write("</details>")
+    readme.close
+    
+    File.delete("specs.md")    
+  end
+end

data/lib/specs_to_readme/version.rb

@@ -0,0 +1,3 @@
+module SpecsToReadme
+  VERSION = "0.1.0"
+end

data/lib/specs_to_readme.rb

@@ -0,0 +1,6 @@
+require "specs_to_readme/version"
+
+module SpecsToReadme
+  class Error < StandardError; end
+  require 'specs_to_readme/railite' if defined?(Rails)
+end

data/specs_to_readme.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/specs_to_readme/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "specs_to_readme"
+  spec.version       = SpecsToReadme::VERSION
+  spec.authors       = ["Jelani Woods"]
+  spec.email         = ["jelani@firstdraft.com"]
+
+  spec.summary       = %q{Adds rake task that adds rspec descriptions to README.}
+  spec.description   = %q{Adds rake task that adds rspec descriptions to README.}
+  spec.homepage      = "https://github.com/firstdraft/specs_to_readme"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/firstdraft/specs_to_readme"
+  spec.metadata["changelog_uri"] = "https://github.com/firstdraft/specs_to_readme"
+
+  # 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"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: specs_to_readme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jelani Woods
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-08 00:00:00.000000000 Z
+dependencies: []
+description: Adds rake task that adds rspec descriptions to README.
+email:
+- jelani@firstdraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/specs_to_readme.rb
+- lib/specs_to_readme/Rakefile
+- lib/specs_to_readme/railite.rb
+- lib/specs_to_readme/tasks/specs/readme.rake
+- lib/specs_to_readme/version.rb
+- specs_to_readme.gemspec
+homepage: https://github.com/firstdraft/specs_to_readme
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/firstdraft/specs_to_readme
+  source_code_uri: https://github.com/firstdraft/specs_to_readme
+  changelog_uri: https://github.com/firstdraft/specs_to_readme
+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 rake task that adds rspec descriptions to README.
+test_files: []