projectionist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1295fd4b627a53451bf020b7e3f3976ec2d40d53
+  data.tar.gz: db51bff9c54b334573a9308ed9c4b3528330114c
+SHA512:
+  metadata.gz: f787705951e31e8f2b1945c75d29ce079caf82f11e0649f2e5b299783fd9b601d0147ee1dd513e1945fc9653b420c54fe0c799b22c951aec5e7975d272f3ba75
+  data.tar.gz: 520ef649f80267f4500e5ee779c1b82628b2d87ce07b6cb88779ecf9242d95ea0189560c3de289410fc0ece413fb42c53329400a35e0ae6a906fa2b1c0a62b20

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+spec/fixtures/**/*

data/.projections.json

@@ -0,0 +1,5 @@
+{
+    "lib/**/*.rb": {
+        "type": "lib"
+    }
+}

data/.rspec

@@ -0,0 +1,3 @@
+--format Fivemat
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Griffin Smith
+
+MIT License
+
+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,39 @@
+[![Build Status](https://travis-ci.org/glittershark/projectionist.svg?branch=master)](https://travis-ci.org/glittershark/projectionist)
+[![Code Climate](https://codeclimate.com/github/glittershark/projectionist.png)](https://codeclimate.com/github/glittershark/projectionist)
+[![Dependency Status](https://gemnasium.com/glittershark/projectionist.svg)](https://gemnasium.com/glittershark/projectionist)
+
+# Projectionist 
+
+Command-line interface to the [.projections.json](https://github.com/tpope/vim-projectionist) format - WIP
+
+## Installation
+
+    $ gem install projectionist
+
+## Usage
+
+For ease of typing, the executable file for projectionist is `prj`.
+
+Given a `.projections.json` file in the root of your project with the following structure:
+
+```
+{
+    "lib/**/*.rb": {
+        "type": "lib"
+    }
+}
+```
+
+The command to edit `lib/whatever/test.rb` would be:
+
+    $ prj edit lib test
+
+
+## Contributing
+
+1. [Fork it](https://github.com/glittershark/projectionist/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'projectionist/cli'
+
+Projector::CLI.start(ARGV)

data/lib/projectionist.rb

@@ -0,0 +1,6 @@
+require 'projectionist/version'
+require 'projectionist/projections'
+require 'projectionist/cli'
+
+module Projectionist
+end

data/lib/projectionist/cli.rb

@@ -0,0 +1,26 @@
+require 'projectionist'
+require 'thor'
+
+module Projectionist
+  class CLI < Thor
+    attr_accessor :projections
+
+    def initialize(*)
+      @projections = Projectionist::Projections.new
+      super
+    end
+
+    desc 'edit <type> <file>', 'Edit the file for <type> named <file>'
+    option :editor
+    def edit(type, file)
+      editor = options[:editor] || ENV['EDITOR'] || `which vim`
+      file = @projections.file_for type, file
+      exec editor, file
+    end
+
+    desc 'list <type>', 'List all files for <type>'
+    def list(type)
+      puts @projections.files_for(type).join("\n")
+    end
+  end
+end

data/lib/projectionist/projections.rb

@@ -0,0 +1,71 @@
+require 'json'
+
+module Projectionist
+  class Projections
+    attr_reader :types
+    attr_reader :json_file_existed
+
+    def initialize
+      @types = {}
+      load_file
+    end
+
+    def load_file(path = nil)
+      @json = get_json path
+      @json.each do |glob, options|
+        next unless options.key? 'type'
+        @types[options['type']] = options.merge('glob' => glob)
+      end
+    end
+
+    def type?(type)
+      @types.key?(type)
+    end
+
+    def file_for(type, name)
+      return nil unless type? type
+
+      Dir.chdir @basedir
+      glob = build_glob(@types[type]['glob'], name)
+      file = Dir.glob(glob)[0]
+      File.expand_path(file.nil? ? glob : file)
+    end
+
+    def files_for(type)
+      return [] unless type? type
+      Dir.glob(@types[type]['glob']).map { |p| File.expand_path p }
+    end
+
+    private
+
+    def get_json(path)
+      if path.nil?
+        path = projections_path
+        if path.nil?
+          @json_file_existed = false
+          return {}
+        end
+      end
+      @json_file_existed = true
+      File.open(path, 'r') { |f| JSON.parse(f.read) }
+    end
+
+    def projections_path
+      path = File.expand_path './.projections.json'
+      until File.exist? path
+        return nil if [false, '/'].include?(File.dirname path)
+        path = File.expand_path('../../.projections.json', path)
+      end
+      @basedir = File.dirname path
+      path
+    end
+
+    def build_glob(glob, file)
+      # Split the passed file by `/`, then replace all globs that use `*` or
+      # `**` with components of the passed file, in order
+      file_components = file.split('/')
+      glob_components = glob.split(/\*+/)
+      glob_components.zip(file_components).flatten.compact.join('')
+    end
+  end
+end

data/lib/projectionist/version.rb

@@ -0,0 +1,3 @@
+module Projectionist
+  VERSION = '0.1.0'
+end

data/projectionist.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'projectionist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'projectionist'
+  spec.version       = Projectionist::VERSION
+  spec.authors       = ['Griffin Smith']
+  spec.email         = ['wildgriffin45@gmail.com']
+  spec.summary       = 'Command line interface to the .projections.json format'
+  spec.description   = <<-EOF
+    Projectionist allows you to quickly edit files in a project from the command
+    line, using the projections.json format
+  EOF
+  spec.homepage      = 'http://github.com/glittershark/projectionist'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rspec',  '~> 3.0'
+  spec.add_development_dependency 'fivemat', '~> 1.3'
+
+  spec.add_runtime_dependency 'thor', '~> 0.19.1', '>= 0.19'
+end

data/spec/cli_spec.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+describe Projectionist::CLI do
+  before do
+    @cli = Projectionist::CLI.new
+    @old_stderr = $stderr
+    $stderr = StringIO.new
+    @old_stdout = $stdout
+    $stdout = StringIO.new
+  end
+
+  after do
+    $stderr = @old_stderr
+    $stdout = @old_stdout
+  end
+
+  describe '#edit' do
+    before do
+      @cli.edit
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'projectionist'
+require 'json'
+require 'fileutils'
+require 'tmpdir'
+
+RSpec.configure do |config|
+  config.before(:suite) { $tmpdir = Dir.mktmpdir }
+  config.after(:suite)  { FileUtils.remove_entry_secure $tmpdir }
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def fixture_folder
+  $tmpdir
+end
+
+def fixture_file
+  File.join(fixture_folder, '.projections.json')
+end
+
+def read_fixtures
+  File.open(fixture_file, 'r') { |f| JSON.parse(f.read) }
+end
+
+def write_fixtures(hash)
+  File.open(fixture_file, 'w') { |f| f.write(hash.to_json) }
+end
+
+def delete_fixtures
+  File.delete fixture_file if File.exist? fixture_file
+end
+
+def empty_fixtures
+  FileUtils.rm_rf Dir.glob("#{fixture_folder}/*", File::FNM_DOTMATCH)
+end

data/spec/projections_spec.rb

@@ -0,0 +1,167 @@
+require 'helper'
+
+describe Projectionist::Projections do
+  before do
+    @original_dir = Dir.pwd
+    write_fixtures('*/*' => { 'type' => 'test' })
+    Dir.mkdir fixture_folder unless Dir.exist? fixture_folder
+    Dir.chdir fixture_folder
+    @projections = Projectionist::Projections.new
+  end
+
+  after { Dir.chdir @original_dir }
+
+  it 'exists' do
+    expect(@projections).not_to be nil
+  end
+
+  describe '.types' do
+    before do
+      @projections.load_file fixture_file
+    end
+
+    it 'loads the list of types' do
+      expect(@projections.types.keys).to eq ['test']
+    end
+
+    it 'has a method to check if a given type exists' do
+      expect(@projections.type? 'test').to be true
+      expect(@projections.type? 'toast').to be false
+    end
+
+    it 'sets a flag that the file existed' do
+      expect(@projections.json_file_existed).to be true
+    end
+  end
+
+  describe '#load_file' do
+    context 'when in a child directory' do
+      before do
+        write_fixtures('*/*' => { 'type' => 'test' })
+        dir = File.join(fixture_folder, 'otherdir')
+        Dir.mkdir dir unless Dir.exist? dir
+        Dir.chdir dir
+        @projections = Projectionist::Projections.new
+        @projections.load_file
+      end
+
+      it 'still loads the file' do
+        expect(@projections.types.keys).to eq ['test']
+      end
+
+      it 'still sets a flag that the file existed' do
+        expect(@projections.json_file_existed).to be true
+      end
+    end
+
+    context 'without a config file' do
+      before do
+        Dir.chdir fixture_folder
+        delete_fixtures
+        @projections = Projectionist::Projections.new
+        @projections.load_file
+      end
+
+      it "sets a flag that the file didn't exist" do
+        expect(@projections.json_file_existed).to be false
+      end
+    end
+  end
+
+  describe '#files_for' do
+    let(:test_dir)   { File.join(fixture_folder, 'test') }
+    let(:test_files) { (1..10).map { |n| File.join(test_dir, "test_#{n}.rb") } }
+
+    before do
+      write_fixtures('test/test_*.rb' => { 'type' => 'test' })
+      Dir.mkdir(test_dir) unless Dir.exist? test_dir
+
+      test_files.each { |f| File.open(f, 'w') }
+
+      # make bad test files as well
+      5.times do |n|
+        file = File.join(test_dir, "bad_#{n}.rb")
+        File.open(file, 'w')
+      end
+
+      @projections.load_file
+    end
+
+    context 'with a valid type' do
+      it 'matches the correct files' do
+        expect(@projections.files_for 'test').to match_array(test_files)
+      end
+    end
+
+    context 'without a valid type' do
+      it 'returns an empty array' do
+        expect(@projections.files_for 'toast').to eq []
+      end
+    end
+  end
+
+  describe '#file_for' do
+    context 'with simple globs' do
+      let(:test_dir)  { File.join(fixture_folder, 'test') }
+      let(:test_file) { File.join(test_dir, 'file.rb') }
+      before do
+        write_fixtures('test/*.rb' => { 'type' => 'test' })
+        Dir.mkdir(test_dir) unless Dir.exist? test_dir
+        File.open(test_file, 'w')
+        Dir.chdir fixture_folder
+        @projections.load_file
+      end
+
+      context 'with a valid type' do
+        subject { @projections.file_for('test', 'file') }
+        it { is_expected.to eq test_file }
+      end
+
+      context 'without a valid type' do
+        subject { @projections.file_for('toast', 'file') }
+        it { is_expected.to be_nil }
+      end
+
+      context "with a file that doesn't exist" do
+        subject { @projections.file_for('test', 'nonexistent') }
+        it { is_expected.to eq File.join(test_dir, 'nonexistent.rb') }
+      end
+
+      context 'with other files in the directory' do
+        let(:other_test_file) { File.join(test_dir, 'abc.rb') }
+        before do
+          File.open(other_test_file, 'w')
+        end
+
+        it 'matches the other file' do
+          expect(@projections.file_for('test', 'abc')).to eq other_test_file
+        end
+
+        it 'matches the old file' do
+          expect(@projections.file_for('test', 'file')).to eq test_file
+        end
+      end
+
+      context 'in a child directory' do
+        before { Dir.chdir test_dir }
+        subject { @projections.file_for('test', 'file') }
+        it { is_expected.to eq test_file }
+      end
+    end
+
+    context 'with multi-level globs' do
+      let(:test_dir)  { File.join(fixture_folder, 'test', 'foobar') }
+      let(:test_file) { File.join(test_dir, 'test_file.rb') }
+      before do
+        write_fixtures('test/**/test_*.rb' => { 'type' => 'test' })
+        FileUtils.mkdir_p test_dir unless Dir.exist? test_dir
+        File.open(test_file, 'w')
+        Dir.chdir fixture_folder
+        @projections.load_file
+      end
+
+      subject { @projections.file_for 'test', 'foobar/file' }
+      it { is_expected.to eq test_file }
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: projectionist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Griffin Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: |2
+      Projectionist allows you to quickly edit files in a project from the command
+      line, using the projections.json format
+email:
+- wildgriffin45@gmail.com
+executables:
+- prj
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".projections.json"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/prj
+- lib/projectionist.rb
+- lib/projectionist/cli.rb
+- lib/projectionist/projections.rb
+- lib/projectionist/version.rb
+- projectionist.gemspec
+- spec/cli_spec.rb
+- spec/helper.rb
+- spec/projections_spec.rb
+homepage: http://github.com/glittershark/projectionist
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Command line interface to the .projections.json format
+test_files:
+- spec/cli_spec.rb
+- spec/helper.rb
+- spec/projections_spec.rb