leg 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 286e3954f7bbf9670f82bd13781641352b4ea836
-  data.tar.gz: 7072bb1eb4f69782adf5b62fdf31bbd52b583f55
+SHA256:
+  metadata.gz: 7834f53c386ef0659ed14743e180619f20998e8180ef0a0f995d87c976a30144
+  data.tar.gz: 841c12497eceedef73aac65e44ff1eab2c8cabf7ca38b4b6410fa0a67ed732e7
 SHA512:
-  metadata.gz: 8098a085df44829793ff34b0c2a8d4ba53aaf7a2bee1c1450e4e760ad7947baef9ec99120e5664dd4722ee988863d42169a6aa8c3add8d0f7170ca5b2ee62843
-  data.tar.gz: 77a5adb334ce1d0ba9fd2582a7d169e2cfee7155b34b148033189bbaa037fe5ed244bb940d2b4a8b7b5d006779e6d36a6693777b7525ebea50217db909f0c8e8
+  metadata.gz: 7b3eb5845cd13d9f8cff44029a6daf87125f0725fdc6a18aed4f6dda7a735f57eb824e0869b320cc3b007d3fc6380d476331fcac7265f0c734468d4648580677
+  data.tar.gz: 30e799503eb2f8ca49f6ca27063285077ce32841b32681d88e6dc9470e19065e2e4aa3cb48d7d1cd85f18393ede18deb06e054914289788b070858644ebed8b8

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.tags
+*.gem

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 jeremy.ruten@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 leg.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    leg (0.0.1)
+      redcarpet (= 3.4.0)
+      rouge (= 2.0.7)
+      rugged (= 0.27.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    redcarpet (3.4.0)
+    rouge (2.0.7)
+    rugged (0.27.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  leg!
+  minitest (~> 5.0)
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jeremy Ruten
+
+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,59 @@
+# leg
+
+Command line tool that helps you make step-by-step programming walkthroughs.
+
+**NOTE:** This project is in a *very* unstable state at the moment. If you really want to use the last "stable" version of this project, head over to the [`snaptoken`](https://github.com/yjerem/leg/tree/snaptoken) branch. (Just know that it will be replaced by a completely new tool and file format in the near future.)
+
+## Install
+
+    $ gem install leg
+
+## Usage
+
+See the [tutorial](TUTORIAL.md)!
+
+---
+
+# Leg
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/leg`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'leg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leg
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/yjerem/leg. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Leg project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yjerem/leg/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/TUTORIAL.md

@@ -0,0 +1,243 @@
+# Creating a step-by-step programming tutorial with `leg`
+
+Install `leg` (you'll need Ruby for this):
+
+```sh
+$ gem install leg
+```
+
+Create a project folder for your tutorial, `cd` into it, and run `leg init`.
+
+```sh
+$ cd ~/projects
+$ mkdir fizzbuzz-tutorial
+$ cd fizzbuzz-tutorial
+$ leg init
+```
+
+This creates two folders: `doc/`, where you will write the text of your
+tutorial, and `step/`, which is a "working directory" that you will use to
+write and modify the actual code steps of your tutorial.
+
+(Also, a hidden `.leg/` directory is created which marks your project folder as
+the root of a `leg` tutorial. This is used by `leg` internally, so you don't
+have to worry about it.)
+
+Create a file in the `step/` folder called `fizzbuzz.js`, with the following
+contents:
+
+```js
+var n = 1;
+while (n <= 100) {
+  console.log(n);
+  n++;
+}
+```
+
+Save it, and then run `leg commit`. Congratulations, you have created your
+first step! Now open `step/fizzbuzz.js` again, and modify it like so:
+
+```js
+var n = 1;
+while (n <= 100) {
+  if (n % 3 == 0) {
+    console.log("Fizz");
+  } else {
+    console.log(n);
+  }
+  n++;
+}
+```
+
+Save it, and then run `leg commit`. Your tutorial now has 2 steps!
+
+## Rendering the tutorial
+
+Run the `leg build` command to build the tutorial into a nice HTML page. Open
+`build/html/tutorial.html` in your web browser to see the result.
+
+You can add text in between the steps of your tutorial by simply adding
+(Markdown-formatted) text to `doc/tutorial.litdiff`. For example:
+
+```diff
+# My FizzBuzz Tutorial
+
+Hello! This is a step-by-step tutorial that teaches you how to write your own
+[FizzBuzz](http://wiki.c2.com/?FizzBuzzTest).
+
+The first thing to do is to write a `while` loop.
+
+~~~ Loop through numbers 1 to 100
+--- /dev/null
++++ b/fizzbuzz.js
+@@ -0,0 +1,5 @@
++var n = 1;
++while (n <= 100) {
++  console.log(n);
++  n++;
++}
+
+Now that we have our `while` loop, with the base case of printing out each
+number, we can start handling special cases. We'll start with handling "Fizz".
+
+~~~ Print "Fizz" for multiples of 3
+--- a/fizzbuzz.js
++++ b/fizzbuzz.js
+@@ -1,5 +1,9 @@
+|var n = 1;
+|while (n <= 100) {
+-  console.log(n);
++  if (n % 3 == 0) {
++    console.log("Fizz");
++  } else {
++    console.log(n);
++  }
+|  n++;
+|}
+```
+
+## Adding the rest of the steps
+
+```js
+var n = 1;
+while (n <= 100) {
+  if (n % 3 == 0) {
+    console.log("Fizz");
+  } else if (n % 5 == 0) {
+    console.log("Buzz");
+  } else {
+    console.log(n);
+  }
+  n++;
+}
+```
+
+```js
+var n = 1;
+while (n <= 100) {
+  if (n % 3 == 0) {
+    console.log("Fizz");
+  } else if (n % 5 == 0) {
+    console.log("Buzz");
+  } else {
+    console.log(n);
+  }
+  n++;
+}
+```
+
+```js
+var n = 1;
+while (n <= 100) {
+  if (n % 3 == 0) {
+    console.log("Fizz");
+  } else if (n % 5 == 0) {
+    console.log("Buzz");
+  } else if (n % 15 == 0) {
+    console.log("FizzBuzz");
+  } else {
+    console.log(n);
+  }
+  n++;
+}
+```
+
+## Amending a step
+
+Oops, that last step we committed has a bug! Let's fix that. In
+`step/fizzbuzz.js`, move the `n % 15` case above the other two cases:
+
+```js
+var n = 1;
+while (n <= 100) {
+  if (n % 15 == 0) {
+    console.log("FizzBuzz");
+  } else if (n % 3 == 0) {
+    console.log("Fizz");
+  } else if (n % 5 == 0) {
+    console.log("Buzz");
+  } else {
+    console.log(n);
+  }
+  n++;
+}
+```
+
+Now run the `leg amend` command, and it will overwrite the step you committed
+with this new code.
+
+## Resolving conflicts
+
+Let's try something a little more challenging. Let's say we want to rewrite our
+steps to use a `for` loop instead of a `while` loop. That means going back and
+amending the first step of our tutorial.
+
+We can do that by running `leg 1` to checkout the first step of the tutorial
+into the `step/` folder. Then modify `step/fizzbuzz.js` to look like this:
+
+```js
+for (var n = 1; n <= 100; n++) {
+  console.log(n);
+}
+```
+
+Now run `leg amend`. `leg` will try to apply the change you just made to all
+the steps that come after it. Often, with large files, it can do this
+automatically. But sometimes you will have to resolve merge conflicts manually.
+
+In this case, after running `leg amend`, you will get a message saying that you
+need to resolve a merge conflict with step 2. To resolve the conflict, open
+`step/fizzbuzz.js` and resolve it by hand, or use a merge tool. The final
+result should look like this:
+
+```js
+for (var n = 1; n <= 100; n++) {
+  if (n % 3 == 0) {
+    console.log("Fizz");
+  } else {
+    console.log(n);
+  }
+}
+```
+
+When the conflict is resolved and you've saved `step/fizzbuzz.js`, run
+`leg resolve` to continue.
+
+## Inserting steps
+
+So far, whenever we've run `leg commit` we've been adding steps to the end of
+our tutorial. We can also insert commits in the middle of our tutorial by
+running `leg <step-number>`, making changes, and running `leg commit`. This
+will add step(s) *after* the given `<step-number>`.
+
+For example, let's add a step after step 1 that prints out a welcome message at
+the beginning of the program. First, run `leg 1`. This checks out step 1 into
+the `step/` folder. Now modify `step/fizzbuzz.js` thusly:
+
+```js
+console.log("Welcome to fizzbuzz!");
+
+for (var n = 1; n <= 100; n++) {
+  console.log(n);
+}
+```
+
+Save the file and run `leg commit`. A new step 2 will be inserted and all the
+steps afterward will be bumped up one. Note that there may be conflicts that
+need to be resolved, as is always possible when making changes to past steps.
+
+## Splitting a step into multiple steps
+
+(The example here will be splitting the `n % 15` step into a step that does
+`n % 3 == 0 && n % 5 == 0` and then a step that simplifies that to `n % 15`.
+And maybe I'll think of a third step it can be split into...)
+
+## Reording steps
+
+(Here we'll try moving the welcome message step to the end of the tutorial.)
+
+## Squashing multiple steps into a single step
+
+(I guess here we'll undo the splitting into steps of `n % 15` that we did
+earlier, for lack of any better ideas.)
+