braid 1.1.4 → 1.1.7

data/lib/braid/sorbet/fake_runtime.rb

@@ -0,0 +1,68 @@
+# typed: ignore
+
+# This file contains a fake implementation of the subset of `sorbet-runtime`
+# used by Braid that performs no runtime checks.  See the "Type checking"
+# section of development.md for background.
+
+require 'singleton'
+
+# Create our fake module at `Braid::T` so that if someone loads Braid into the
+# same Ruby interpreter as other code that needs the real sorbet-runtime, we
+# don't break the other code.  (We don't officially support loading Braid as a
+# library, but we may as well go ahead and put this infrastructure in place.)
+# Code in the `Braid` module still uses normal references to `T`, so the Sorbet
+# static analyzer (which doesn't read this file) doesn't see anything out of the
+# ordinary, but those references resolve to `Braid::T` at runtime according to
+# Ruby's constant lookup rules.
+module Braid
+  module T
+
+    module Sig
+      def sig; end
+    end
+    def self.let(value, type)
+      value
+    end
+
+    # NOTICE: Like everything else in the fake Sorbet runtime (e.g., `sig`),
+    # these do not actually perform runtime checks.  Currently, if you want a
+    # runtime check, you have to implement it yourself.  We considered defining
+    # wrapper functions with different names to make this clearer, but then we'd
+    # lose the extra static checks that Sorbet performs on direct calls to
+    # `T.cast` and `T.must`.
+    def self.cast(value, type)
+      value
+    end
+    def self.must(value)
+      value
+    end
+
+    class FakeType
+      include Singleton
+    end
+    FAKE_TYPE = FakeType.instance
+
+    def self.type_alias
+      FAKE_TYPE
+    end
+
+    def self.nilable(type)
+      FAKE_TYPE
+    end
+    def self.untyped
+      FAKE_TYPE
+    end
+    Boolean = FAKE_TYPE
+    module Array
+      def self.[](type)
+        FAKE_TYPE
+      end
+    end
+    module Hash
+      def self.[](key_type, value_type)
+        FAKE_TYPE
+      end
+    end
+
+  end
+end

data/lib/braid/sorbet/setup.rb

@@ -0,0 +1,18 @@
+# typed: strict
+
+# Code to set up the Sorbet runtime and Sorbet-related utilities used throughout
+# the Braid code.  Called by `lib/braid.rb` and `lib/braid/operations_lite.rb`
+# before any other Braid code is loaded.
+
+env_use_sorbet_runtime = ENV['BRAID_USE_SORBET_RUNTIME']
+if env_use_sorbet_runtime == '1'
+  require 'sorbet-runtime'
+elsif [nil, '0'].include?(env_use_sorbet_runtime)
+  require 'braid/sorbet/fake_runtime'
+else
+  puts <<-MSG
+Braid: Error: BRAID_USE_SORBET_RUNTIME environment variable has invalid
+value #{env_use_sorbet_runtime.inspect}; it must be "1", "0", or unset.
+MSG
+  exit(1)
+end

data/lib/braid/version.rb

@@ -1,3 +1,3 @@
 module Braid
-  VERSION = '1.1.4'.freeze
+  VERSION = '1.1.7'.freeze
 end

data/lib/braid.rb

@@ -1,6 +1,11 @@
+# typed: strict
+
+require 'braid/sorbet/setup'
 require 'braid/version'
 
 module Braid
+  extend T::Sig
+
   OLD_CONFIG_FILE      = '.braids'
   CONFIG_FILE          = '.braids.json'
 
@@ -16,31 +21,46 @@ module Braid
   # distributions.
   REQUIRED_GIT_VERSION = '2.3.0'
 
+  @verbose = T.let(false, T::Boolean)
+
+  sig {returns(T::Boolean)}
   def self.verbose
     !!@verbose
   end
 
+  # TODO (typing): One would think `new_value` shouldn't be nilable, but
+  # apparently `lib/braid/main.rb` passes nil sometimes. Is that easy to fix?
+  # (Ditto with `self.force=` below.)
+  sig {params(new_value: T.nilable(T::Boolean)).void}
   def self.verbose=(new_value)
     @verbose = !!new_value
   end
 
+  @force = T.let(false, T::Boolean)
+
+  sig {returns(T::Boolean)}
   def self.force
     !!@force
   end
 
+  sig {params(new_value: T.nilable(T::Boolean)).void}
   def self.force=(new_value)
     @force = !!new_value
   end
 
+  sig {returns(T::Boolean)}
   def self.use_local_cache
     [nil, 'true', '1'].include?(ENV['BRAID_USE_LOCAL_CACHE'])
   end
 
+  sig {returns(String)}
   def self.local_cache_dir
     File.expand_path(ENV['BRAID_LOCAL_CACHE_DIR'] || "#{ENV['HOME']}/.braid/cache")
   end
 
   class BraidError < StandardError
+    extend T::Sig
+    sig {returns(String)}
     def message
       value = super
       value if value != self.class.name
@@ -48,6 +68,7 @@ module Braid
   end
 
   class InternalError < BraidError
+    sig {returns(String)}
     def message
       "internal error: #{super}"
     end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: braid
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.7
 platform: ruby
 authors:
 - Cristi Balan
 - Norbert Crombach
 - Peter Donald
 - Matt McCutchen
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: main
@@ -104,19 +104,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE
-- README.md
-- Rakefile
-- _config.yml
-- bin/braid
-- braid.gemspec
-- braids-json.schema.json
-- config_versions.md
+- exe/braid
 - lib/braid.rb
+- lib/braid/check_gem.rb
 - lib/braid/command.rb
 - lib/braid/commands/add.rb
 - lib/braid/commands/diff.rb
@@ -127,71 +118,17 @@ files:
 - lib/braid/commands/update.rb
 - lib/braid/commands/upgrade_config.rb
 - lib/braid/config.rb
+- lib/braid/main.rb
 - lib/braid/mirror.rb
 - lib/braid/operations.rb
 - lib/braid/operations_lite.rb
+- lib/braid/sorbet/fake_runtime.rb
+- lib/braid/sorbet/setup.rb
 - lib/braid/version.rb
-- spec/config_spec.rb
-- spec/fixtures/shiny-conf-1.0.9-lock/.braids.json
-- spec/fixtures/shiny-conf-1.0.9-lock/expected.braids.json
-- spec/fixtures/shiny-conf-1.0.9-lock/skit1/layouts/layout.liquid
-- spec/fixtures/shiny-conf-1.0.9-lock/skit1/preview.png
-- spec/fixtures/shiny-conf-breaking-changes/.braids
-- spec/fixtures/shiny-conf-breaking-changes/Spoon-Knife/README.md
-- spec/fixtures/shiny-conf-breaking-changes/Spoon-Knife/index.html
-- spec/fixtures/shiny-conf-breaking-changes/Spoon-Knife/styles.css
-- spec/fixtures/shiny-conf-breaking-changes/expected.braids.json
-- spec/fixtures/shiny-conf-breaking-changes/skit1/layouts/layout.liquid
-- spec/fixtures/shiny-conf-breaking-changes/skit1/preview.png
-- spec/fixtures/shiny-conf-future/.braids.json
-- spec/fixtures/shiny-conf-future/skit1/layouts/layout.liquid
-- spec/fixtures/shiny-conf-future/skit1/preview.png
-- spec/fixtures/shiny-conf-json-old-name/.braids
-- spec/fixtures/shiny-conf-json-old-name/expected.braids.json
-- spec/fixtures/shiny-conf-json-old-name/skit1/layouts/layout.liquid
-- spec/fixtures/shiny-conf-json-old-name/skit1/preview.png
-- spec/fixtures/shiny-conf-yaml/.braids
-- spec/fixtures/shiny-conf-yaml/expected.braids.json
-- spec/fixtures/shiny-conf-yaml/skit1/layouts/layout.liquid
-- spec/fixtures/shiny-conf-yaml/skit1/preview.png
-- spec/fixtures/shiny/README
-- spec/fixtures/shiny/other-skit/layout.liquid
-- spec/fixtures/shiny/skit-layout.liquid.test
-- spec/fixtures/shiny/skit1.test
-- spec/fixtures/shiny_skit1.2_merged/layouts/layout.liquid
-- spec/fixtures/shiny_skit1.2_merged/preview.png
-- spec/fixtures/shiny_skit1_conflicting/layouts/layout.liquid
-- spec/fixtures/shiny_skit1_conflicting/preview.png
-- spec/fixtures/shiny_skit1_mergeable/layouts/layout.liquid
-- spec/fixtures/shiny_skit1_mergeable/preview.png
-- spec/fixtures/skit1.1/layouts/layout.liquid
-- spec/fixtures/skit1.1_with_filter/.gitattributes
-- spec/fixtures/skit1.1_with_filter/layouts/layout.liquid
-- spec/fixtures/skit1.1_with_filter/preview.png
-- spec/fixtures/skit1.1x/layouts/layout.liquid
-- spec/fixtures/skit1.2/layouts/layout.liquid
-- spec/fixtures/skit1.3/layouts/README.md
-- spec/fixtures/skit1.3/layouts/layout.liquid
-- spec/fixtures/skit1/layouts/layout.liquid
-- spec/fixtures/skit1/preview.png
-- spec/fixtures/skit1_with_filter/.gitattributes
-- spec/fixtures/skit1_with_filter/layouts/layout.liquid
-- spec/fixtures/skit1_with_filter/preview.png
-- spec/integration/adding_spec.rb
-- spec/integration/config_versioning_spec.rb
-- spec/integration/diff_spec.rb
-- spec/integration/integration_helper.rb
-- spec/integration/push_spec.rb
-- spec/integration/remove_spec.rb
-- spec/integration/status_spec.rb
-- spec/integration/updating_spec.rb
-- spec/mirror_spec.rb
-- spec/operations_spec.rb
-- spec/test_helper.rb
 homepage: https://github.com/cristibalan/braid
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--line-numbers"
 - "--inline-source"
@@ -211,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: A simple tool for tracking vendor branches in git.
 test_files: []

data/.gitignore

@@ -1,16 +0,0 @@
-*.gem
-*.rbc
-*.sw?
-.DS_Store
-.bundle
-.idea
-coverage
-nbproject
-pkg
-pkg/*
-rdoc
-/*.iml
-/*.ipr
-/*.iws
-/.rakeTasks
-/Gemfile.lock

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.2
-  - jruby-9.2.6.0
-addons:
-  apt:
-    sources:
-    - git-core
-    packages:
-    - git
-git:
-  depth: 10

data/CONTRIBUTING.md

@@ -1,24 +0,0 @@
-# How to Contribute
-
-Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
-
-* Fork it
-* Create your feature branch (`git checkout -b my-new-feature`)
-* Commit your changes (`git commit -am 'Add some feature'`)
-* Push to the branch (`git push origin my-new-feature`)
-* Create new Pull Request
-
-Pester us if we don't get your Pull Requests merged in a timely fashion. :)
-
-## How to speed the merging of pull requests
-
-* Make commits of logical units.
-* Ensure your commit messages help others understand what you are doing and why.
-* Check for unnecessary whitespace with `git diff --check` before committing.
-* Maintain the same code style.
-* Maintain the same level of test coverage or improve it.
-
-## Additional Resources
-
-* [General GitHub documentation](http://help.github.com/)
-* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/README.md

@@ -1,234 +0,0 @@
-# Braid
-
-[![Build Status](https://secure.travis-ci.org/cristibalan/braid.svg?branch=master)](http://travis-ci.org/cristibalan/braid)
-[![Gem](https://img.shields.io/gem/v/braid.svg?maxAge=2592000)](https://rubygems.org/gems/braid)
-
-Braid is a simple tool to help track vendor branches in a
-[Git](http://git-scm.com/) repository.
-
-## Motivation
-
-Vendoring allows you take the source code of an external library and ensure it's
-version controlled along with the main project. This is in contrast to including
-a reference to a packaged version of an external library that is available in a
-binary artifact repository such as Maven Central, RubyGems or NPM.
-
-Vendoring is useful when you need to patch or customize the external libraries
-or the external library is expected to co-evolve with the main project. The
-developer can make changes to the main project and patch the library in a single
-commit.
-
-The problem arises when the external library makes changes that you want to
-integrate into your local vendored version or the developer makes changes to the
-local version that they want integrated into the external library.
-
-A typical "implementation" of vendoring is to simply download or checkout the
-source for the external library, remove the `.git` or `.svn` directories and
-commit it to the main source tree. However this approach makes it very difficult
-to update the library. When you want to update the library do you re-apply your
-local changes onto a new copy of the vendored library or do you re-apply the
-changes from the external library to local version? Both cases involve manual
-generation and application of patch files to source trees.
-
-This is where Braid comes into play. Braid makes it easy to vendor in remote git
-repositories and use an automated mechanism for updating the external library
-and generating patches to upgrade the external library.
-
-Braid creates a file `.braids.json` in the root of your repository that contains
-references to external libraries or mirrors. The configuration allows you to control
-aspects of the mirroring process such as;
-
-* whether the mirror is locked to a particular version of the external library.
-* whether the mirror is tracking a tag or a branch.
-* whether the mirror includes the entire external library or just a subdirectory.
-
-## Installation
-
-    gem install braid
-
-## Quick usage - ruby project
-
-Let's assume we're writing the project `myproject` that needs grit in lib/grit. Initialize the repo (nothing braid related here):
-
-    git init myproject
-    cd myproject
-    touch README
-    git add README
-    git commit -m "initial commit"
-
-Now let's vendor grit:
-
-    braid add git://github.com/mojombo/grit.git lib/grit
-
-And you're done! Braid vendored grit into lib/grit. Feel free to inspect the changes with git log or git show.
-
-If further down the line, you want to bring new changes from grit into your repository, just update the mirror:
-
-    braid update lib/grit
-
-If you make changes to the grit library and want to generate a patch file so that you can submit the patch file
-to the grit project:
-
-    braid diff lib/grit > grit.patch
-
-Alternatively you can push changes back to the source directory directly using the following command. The command
-will push the changes to the branch `myproject_customizations` that has been branched off the source branch (`master`
-in this example). Omit the `--branch` argument to push directly to the source branch.
-
-    braid push lib/grit --branch myproject_customizations
-
-Once those changes have been applied to grit you probably want to update your local version of grit again.
-
-    braid update lib/grit
-
-## More usage
-
-Use the built in help system to find out about all commands and options:
-
-    braid help
-    braid help add # or braid add --help
-
-### Examples
-
-#### Adding a mirror
-
-    braid add git://github.com/rails/rails.git vendor/rails
-
-#### Adding a subdirectory from a mirror
-
-This is useful if you want to add a subdirectory from a mirror into your own project.
-
-    braid add --path dist https://github.com/twbs/bootstrap.git vendor/assets/bootstrap
-
-#### Adding a mirror based on a branch
-
-    braid add --branch 5-0-stable https://github.com/rails/rails.git vendor/rails
-
-#### Adding a mirror based on a tag
-
-    braid add --tag v1.0 https://github.com/realityforge/backpack.git vendor/tools/backpack
-
-#### Adding mirror locked to a revision
-
-    braid add --revision bf1b1e0 git://github.com/rails/rails.git vendor/rails
-
-#### Updating mirrors
-
-    # Update a specific mirror
-    braid update vendor/plugins/cache_fu
-    # Update all mirrors
-    braid update
-
-#### Updating mirrors with conflicts
-
-If a braid update creates a conflict, braid will stop execution and leave the partially committed
-files in your working copy, just like a normal git merge conflict would.
-
-You will then have to resolve all conflicts and manually run `git commit`. The commit message is
-already prepared.
-
-If you want to cancel the braid update and the merge, you'll have to reset your working copy and
-index with `git reset --hard`.
-
-#### Locking and unlocking mirrors
-
-Lock to a particular version in the mirror.
-
-    braid update --revision 6c1c16b vendor/rails
-
-Go back to tracking a particular branch.
-
-    braid update --branch master vendor/rails
-
-#### Showing local changes made to mirrors
-
-    braid diff vendor/rails
-
-## Supported environments
-
-As of this writing (2022-01-20), we try to keep Braid working at least on Linux,
-OSX and Windows with recent versions of its dependencies (Git, Ruby, gems, etc.).
-Your mileage on other operating systems or with other versions of dependencies
-may vary.  We don't have a procedure in place to systematically test Braid in
-multiple environments; typically, Braid developers just run the test suite on
-their own systems with whatever is installed.  So breakages may sometimes occur.
-If you run into an environment-related problem, please report it and we'll fix
-it if feasible.  Contributions to improve testing of Braid would be welcome.
-
-## Braid version compatibility
-
-Since Braid has been regularly changing the configuration format and adding new
-features that some projects may choose to rely on, and somewhat less often
-making breaking changes in how the configuration is handled, problems can arise
-if different developers work on the same project using different versions of
-Braid.  Since version 1.1.0, Braid refuses to operate if it detects potentially
-problematic version skew.  If this happens, Braid will tell you what you can do.
-If you'd like an overview of what to expect, read on.
-
-Roughly speaking, the `.braids.json` configuration file contains a configuration
-version number that corresponds to a range of compatible Braid minor versions
-(`x.y`). "Patch" upgrades to Braid (i.e., `x.y.z` -> `x.y.(z+1)`) will never
-(intentionally!) have configuration compatibility implications and are always
-recommended as they may fix critical bugs.
-
-If you use a Braid version too old for your configuration file, Braid will
-direct you to the [configuration version history page](config_versions.md) with
-instructions to upgrade Braid.  If you use a Braid version too new, Braid will
-tell you how you can upgrade your configuration file or find a compatible older
-Braid version to use.  (As an exception, a newer version of Braid can run
-read-only commands on an older configuration file without upgrading it if there
-are no breaking changes.)  If you upgrade your configuration file, then other
-developers on the project may need to upgrade Braid.  Braid does not support
-downgrading a configuration file, though you can revert the commit that upgraded
-it if you haven't made any subsequent changes to the configuration.
-
-If you work on multiple projects, you may need to install multiple versions of
-Braid and manually run the correct version for each project.  Fortunately, the
-RubyGems system makes this reasonably straightforward.
-
-Another approach is to standardize the Braid version for a project by listing
-Braid in a `Gemfile` (either checking in `Gemfile.lock` or using a version
-constraint in the `Gemfile`) and run the project's version of Braid via
-[Bundler](http://bundler.io/) with `bundle exec braid`.  Even non-Ruby projects
-can do this if it's acceptable to have a `Gemfile` and `Gemfile.lock`.  Ruby
-projects that don't want Braid to interact with their other gems can potentially
-put the `Gemfile` in a subdirectory and provide a wrapper script for `bundle`
-that sets the `BUNDLE_GEMFILE` environment variable.  We do not yet have enough
-experience with this approach to make a firm recommendation for or against it.
-
-This is the best design we could find to prevent surprises and adequately
-support normal development processes while minimizing the additional maintenance
-cost of the version compatibility mechanism.  We want to have a scheme in place
-that is robust enough to make it reasonable to encourage serious adoption of
-Braid, yet we don't want to spend extra work adding conveniences until there's
-evidence of sufficient demand for them.
-
-## Contributing
-
-We appreciate any patches, error reports and usage ideas you may have. Please
-submit an issue or pull request on GitHub.
-
-### Subversion
-
-While preparing to release Braid v1.0 the support for subversion repositories was removed as
-there was no active maintainers and inadequate test coverage. If there is anyone motivated to
-re-add and maintain the Subversion support, please contact the authors.
-
-# Authors
-
-* Cristi Balan
-* Norbert Crombach
-* Peter Donald
-* Matt McCutchen
-
-## Contributors (alphabetically)
-
-* Alan Harper
-* Brad Durrow
-* Christoph Sturm
-* Dennis Muhlestein
-* Ferdinand Svehla
-* Michael Klishin
-* Roman Heinrich
-* Travis Tilley
-* Tyler Rick

data/Rakefile

@@ -1,12 +0,0 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rake'
-require 'rspec/core/rake_task'
-desc 'Run all specs'
-RSpec::Core::RakeTask.new :spec  do |task|
-  task.rspec_opts = %w{--backtrace}
-end
-
-desc 'Test and package the gem'
-task :default => [:spec, :build]

data/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-tactile

data/braid.gemspec

@@ -1,35 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require 'braid/version'
-
-Gem::Specification.new do |s|
-  s.name               = %q{braid}
-  s.version            = Braid::VERSION
-  s.platform           = Gem::Platform::RUBY
-
-  s.authors            = ['Cristi Balan', 'Norbert Crombach', 'Peter Donald', 'Matt McCutchen']
-  s.email              = %q{evil@che.lu norbert.crombach@primetheory.org peter@realityforge.org matt@mattmccutchen.net}
-
-  s.homepage           = %q{https://github.com/cristibalan/braid}
-  s.summary            = %q{A simple tool for tracking vendor branches in git.}
-  s.description        = %q{A simple tool for tracking vendor branches in git.}
-
-  s.rubyforge_project  = %q{braid}
-
-  s.files              = `git ls-files`.split("\n")
-  s.test_files         = `git ls-files -- {spec}/*`.split("\n")
-  s.executables        = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths      = %w(lib)
-
-  s.rdoc_options       = %w(--line-numbers --inline-source --title braid --main)
-
-  s.required_ruby_version = '>= 2.2.0'
-  s.add_dependency(%q<main>, ['>= 4.7.3'])
-  # XXX: Minimum version?
-  s.add_dependency(%q<json>)
-
-  s.add_development_dependency(%q<rspec>, ['>= 3.4.4'])
-  s.add_development_dependency(%q<mocha>, ['>= 0.9.11'])
-  s.add_development_dependency(%q<rake>)
-  s.add_development_dependency(%q<bundler>)
-end