wtf-doc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18144acf30d164920c60d87cf73263c1945b0a6f
+  data.tar.gz: 1a1a41bea9fcaf88b6137421b76880a154c14a02
+SHA512:
+  metadata.gz: ad8366a8fc63074cc7425342ae2307aca7ceb69bc6b819f7da09ef361a38c373d49d10d4a58fbf8eb1f023cd34731348f299e765b6b4fe73b4674cc4f1240445
+  data.tar.gz: 1e9371509d7a33c90fd0baa44982875a68d85993e4df4ef0a49cffd4568446755eb14a158192c68ae7d435d4e3a69e8f711696de46adfb1194bb0d2f5c661c96

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/.wtf
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wtf.gemspec
+gemspec

data/README.md

@@ -0,0 +1,21 @@
+# Wtf
+
+Never run into so many folders that you have no idea what contains what? This is a tool to add a descriptions to Mac OS Folders
+
+
+## Installation
+
+Iinstall it yourself as:
+
+    $ gem install wtf
+
+## Usage
+
+TODO: instructions
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lorenzosinisi/wtf.
+
+# wtf

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 "wtf"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/wtf

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby -wU
+
+require "bundler/setup"
+require "wtf"
+
+Wtf::CLI::Application.start

data/lib/wtf/cli/here.rb

@@ -0,0 +1,26 @@
+require 'thor'
+
+module Wtf
+  module CLI
+    class Application < Thor
+      
+      desc "here", "This will read you the description of this folder"
+      def here
+        puts Wtf::Core.new.content
+      end
+      default_task :here
+
+      desc "doc", "This will write the description of this folder.
+                        \n\n Usage:
+                        \n\n wtf document -c 'my documentation'"
+      option :c
+      def doc(*args)
+        content = options[:c] + " " + args.join(" ")
+        Wtf::Core.new.write(content) if options[:c]
+        puts "Folder documentation added:"
+        puts Wtf::Core.new.content
+      end
+
+    end
+  end
+end

data/lib/wtf/core.rb

@@ -0,0 +1,48 @@
+module Wtf
+  class Core
+      
+    def current_path
+      Dir.pwd
+    end
+
+    def has_documentation?
+      File.exist?(current_path + wtf_file)
+    end
+
+    alias :is_documented? :has_documentation?
+
+    def wtf_file
+      '/.wtf'
+    end
+
+    def clean
+      if is_documented?
+        File.delete(current_path + wtf_file)
+        true
+      else
+        puts not_documented
+        nil
+      end
+    end
+
+    def not_documented
+      "This folder is not documented."
+    end
+
+    def write(data)
+      File.open(current_path + '/.wtf', 'w') {|f| f.write(data) }
+    end
+
+    def content
+      if is_documented?
+        data = File.read(current_path + wtf_file)
+        data
+      else
+        puts not_documented
+      end
+    end
+
+    alias :read_documentation :content
+
+  end
+end

data/lib/wtf/version.rb

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

data/lib/wtf.rb

@@ -0,0 +1,6 @@
+require "wtf/version"
+require "wtf/core"
+require "wtf/cli/here"
+
+module Wtf
+end

data/wtf.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wtf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wtf-doc"
+  spec.version       = Wtf::VERSION
+  spec.authors       = ["Lorenzo Sinisi"]
+  spec.email         = ["lasslo.net@gmail.com"]
+
+  spec.summary       = %q{Command line utility to add descriptions to folders.}
+  spec.description   = %q{Command line utility to add descriptions to folders}
+  spec.homepage      = "https://github.com/lorenzosinisi/wtf"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["wtf"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'thor', "0.19.1"
+  spec.add_dependency 'httparty'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: wtf-doc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lorenzo Sinisi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command line utility to add descriptions to folders
+email:
+- lasslo.net@gmail.com
+executables:
+- wtf
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/wtf
+- lib/wtf.rb
+- lib/wtf/cli/here.rb
+- lib/wtf/core.rb
+- lib/wtf/version.rb
+- wtf.gemspec
+homepage: https://github.com/lorenzosinisi/wtf
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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 utility to add descriptions to folders.
+test_files: []