examplify 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0c192c87b698ab4fd1c0ddd819272c2e78ac35b
+  data.tar.gz: 770ffad0a0fbf87282e0895b50e3087f9ed6887e
+SHA512:
+  metadata.gz: fee3edb8b37706d68f3d9337d63c0f1df3a9626ccc10d53ce17017ee7c8d158b5088820e6247df51a6f00af88519d2702849fda943088496a3d01db5910bb322
+  data.tar.gz: 80dce84954c39e403924d71b03e14d4ac6bd2b825f7eda40a3f750ee618de26dcb529b4c435ada40c53d88bd3a9f836af608c898c3a4140591b8165ed7c7039d

data/README.md

@@ -0,0 +1,36 @@
+# Examplify
+
+Examplify squashes multiple files together into one for easily pasting into a
+gist or a markdown document. It puts comments/headers with the filenames.
+
+## Example output
+
+```
+# root/file.rb
+contents of file.rb
+
+# root/another_file.rb
+contents of another_file.rb
+```
+
+## Usage
+
+```bash
+# entire folder
+examplify project/
+
+# only ruby files
+examplify project/ --only=*.rb
+
+# without some files
+examplify project/ --exclude=*.md
+
+# choose specific files
+examplify file.rb file2.rb
+```
+
+## Caveats
+
+- globbing only matches on filenames for now
+- zsh users probably want to `noglob examplify`, otherwise the shell will try to glob
+- **very** weird behaviour can occur when dogfeeding this gem and not exluding the `.gem` files.

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

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require "docopt"
+require_relative '../lib/examplify.rb'
+
+doc = <<DOCOPT
+Examplify
+
+Usage:
+  examplify <paths>... [--exclude=glob|--only=glob] [--dry-run]
+  examplify -h | --help
+  examplify --version
+
+Options:
+  -h --help        Show this screen.
+  --version        Show version.
+  -n --dry-run     Only output paths.
+  --exclude=glob   Glob pattern of files to exclude.
+  --only=glob      Glob pattern to filter files.
+
+DOCOPT
+
+begin
+  options = Docopt::docopt(doc)
+
+  list = Examplify.new(options["<paths>"])
+
+  list.filter(options["--only"])     if options["--only"]
+  list.exclude(options["--exclude"]) if options["--exclude"]
+
+  if options['--dry-run']
+    puts list.files
+  else
+    puts list.output
+  end
+
+rescue Docopt::Exit => e
+  puts e.message
+end

data/lib/examplify.rb

@@ -0,0 +1,59 @@
+require 'rake/file_list'
+
+class Examplify
+  attr_reader :files
+
+  def initialize(paths)
+    @files = Rake::FileList[get_list_of_files(paths)]
+  end
+
+  def exclude(glob)
+    files.exclude do |path|
+      glob_matches_file(glob, path)
+    end
+  end
+
+  # inverse of exclude
+  def filter(glob)
+    files.exclude do |path|
+      !glob_matches_file(glob, path)
+    end
+  end
+
+  def output
+    files.map { |path|
+      title   = ["# ", path].join
+      content = File.read(path)
+
+      [title, content].join("\n")
+    }.join("\n")
+  end
+
+  private
+
+  def glob_matches_file(glob, path)
+    filename = path.pathmap("%f")
+    File.fnmatch(glob, filename, File::FNM_DOTMATCH)
+  end
+
+  # given a path or a list of paths to folders or files
+  # returns an array of paths to all files given, and
+  # all files contained in subdirectories of folders,
+  # but without the folders
+  def get_list_of_files(paths)
+    paths = Array(paths)
+
+    paths.flat_map do |path|
+      if File.directory? path
+        get_all_files_inside(path)
+      else
+        [path]
+      end
+    end
+  end
+
+  def get_all_files_inside(folder)
+    # get paths of files recursively, ignoring paths to folders
+    Dir.glob(File.join(folder, '**/*')).reject { |path| File.directory? path }
+  end
+end

data/spec/dummy/one.rb

@@ -0,0 +1 @@
+puts "One"

data/spec/dummy/two.rb

@@ -0,0 +1 @@
+puts "Two"

data/spec/feature_spec.rb

@@ -0,0 +1,52 @@
+describe "examplify" do
+
+  # TODO: Tempdir
+
+  it "outputs files from a folder" do
+    expect(examplify "./spec/dummy").to eq <<-OUTPUT.deindent
+      # ./spec/dummy/one.rb
+      puts "One"
+
+      # ./spec/dummy/two.rb
+      puts "Two"
+    OUTPUT
+  end
+
+  it "joins paths correctly" do
+    expect(examplify "./spec/dummy").to eq examplify "./spec/dummy/"
+  end
+
+  it "ouputs manually listed files" do
+    expect(examplify "./spec/dummy/two.rb ./spec/dummy/one.rb").to eq <<-OUTPUT.deindent
+      # ./spec/dummy/two.rb
+      puts "Two"
+
+      # ./spec/dummy/one.rb
+      puts "One"
+    OUTPUT
+  end
+
+  it "excludes files by globbing" do
+    expect(examplify "./spec/dummy --exclude=*o.rb").to eq <<-OUTPUT.deindent
+      # ./spec/dummy/one.rb
+      puts "One"
+    OUTPUT
+  end
+
+  it "filters files by globbing" do
+    expect(examplify "./spec/dummy --only=two*").to eq <<-OUTPUT.deindent
+      # ./spec/dummy/two.rb
+      puts "Two"
+    OUTPUT
+  end
+
+  it "can do a dry-run" do
+    expect(examplify "./spec/dummy -n").to eq <<-OUTPUT.deindent
+      ./spec/dummy/one.rb
+      ./spec/dummy/two.rb
+    OUTPUT
+  end
+
+  # it "file-prefix, line-prefix"
+  # it "git ls-files"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+def examplify(arguments)
+  `ruby ./bin/examplify #{arguments}`
+end
+
+class String
+  def deindent
+    self.gsub(/ {6}/, '')
+  end
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: examplify
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jimmy Börjesson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Good for pasting an example that's using multiple files into a gist or
+  a blogpost.
+email:
+- lagginglion@gmail.com
+executables:
+- examplify
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/examplify
+- lib/examplify.rb
+- spec/dummy/one.rb
+- spec/dummy/two.rb
+- spec/feature_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alcesleo/examplify
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Outputs an entire project with filenames as comments.
+test_files:
+- spec/dummy/one.rb
+- spec/dummy/two.rb
+- spec/feature_spec.rb
+- spec/spec_helper.rb