tagline 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86d24152825e6c3f83da329e3555758ce0e5ba5a
+  data.tar.gz: 25a39fd47efc9ad678c0b233ffbc897db55c4e1e
+SHA512:
+  metadata.gz: 5dafdcf5d4696b0c2a0147f52379f77934069f43a247f3a510edea0232d0a9429af943431a945c1a6311cec9e8f5bf3b9ca663fad0fa3f1672b47da792730176
+  data.tar.gz: 931c1eb845f66b070c34a3bc036e061c20bb6180a0e09dc6d64e050d5c1e3fa3c5dbe39562fad2cfe0a8afbcad4d4bd6a731c9571b13eb2ee48cc0d9091fa49f

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Max White
+
+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,43 @@
+# Tagline
+
+Simple command line tool for tagging lines of text. Intended for reviewing a long list, separted by new lines. Creates new files for each tag of only the items tagged, so that it can be used to organise lists into sub lists.
+
+## Installation
+
+    $ gem install tagline
+
+## Usage
+
+		$ tagline -f my_list.txt -t tag1:116 -t tag2:100 -t tag3:122
+
+```
+********** Tagline *************
+********************************
+
+ * Press UP to see previous
+ * Press DOWN to see next
+ * Press "t" to toggle tag1
+ * Press "d" to toggle tag2
+ * Press "z" to toggle tag3
+ * Press "n" to toggle next_on_tag
+ * Press CTRL+X to exit
+
+Tags:
+  tag1: false
+  tag2: false
+  tag3: false
+
+=> My first line of text!
+```
+
+The tag argument expects a tagname:ascii-code pair. ascii codes can be looked-up [here](docs/ascii_codes.md).
+
+The default tags are ENTER for pass and 'f' for flag.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tagline/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/bin/tagline

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'slop'
+require 'tagline'
+
+opts = Slop.parse do |o|
+  o.string '-f', '--filename',    'file to be reviewed'
+  o.array '-t', '--tags',        'tag name:ascii code'
+  o.on '-h', '--help',        'print this' do
+    puts(o) && exit
+  end
+end
+
+unless opts[:filename]
+  puts opts
+  exit
+end
+
+filename = File.expand_path(opts[:filename], Dir.getwd)
+fail 'File does not exist' unless File.exist?(filename)
+
+unless opts[:tags].empty?
+  Tagline.tags = opts[:tags].reduce({}) do |h, arg|
+    tag, code = arg.split(':')
+    fail 'Tags must be in name:ascii code pairs, e.g. pass:13' unless code
+    h.merge(tag.to_sym => code.to_i)
+  end
+end
+
+Tagline.review(filename)

data/lib/tagline.rb

@@ -0,0 +1,15 @@
+require 'forwardable'
+require 'tagline/tagger'
+
+module Tagline
+  class << self
+    attr_accessor :next_on_tag, :tags
+
+    def review(filename)
+      Tagger.run_loop(filename)
+    end
+  end
+
+  self.next_on_tag = false
+  self.tags = { pass: 13, flag: 102 }
+end

data/lib/tagline/character_reader.rb

@@ -0,0 +1,37 @@
+require 'highline/system_extensions'
+
+module Tagline
+  class CharacterReader
+    include HighLine::SystemExtensions
+
+    def self.run_loop(*args)
+      new(*args).run_loop
+    end
+
+    UP = 72
+    DOWN = 80
+    N = 110
+    CTRL_X = 24
+
+    def run_loop
+      before_loop
+      loop do
+        case char = get_character.ord
+        when UP
+          up_key
+        when DOWN
+          down_key
+        when N
+          n_key
+        when CTRL_X
+          break
+        else
+          tag(char)
+        end
+      end
+    ensure
+      after_loop
+      exit
+    end
+  end
+end

data/lib/tagline/line.rb

@@ -0,0 +1,20 @@
+module Tagline
+  class Line
+    extend Forwardable
+    attr_reader :text
+    def_delegators :tags, :[], :[]=
+
+    def initialize(text)
+      @text = text
+      @tags = Hash.new(false)
+    end
+
+    def toggle(tag)
+      self[tag] = !self[tag]
+    end
+
+    private
+
+    attr_reader :tags
+  end
+end

data/lib/tagline/line_manager.rb

@@ -0,0 +1,34 @@
+require 'tagline/line'
+
+module Tagline
+  class LineManager
+    extend Forwardable
+    attr_reader :lines
+
+    def initialize(filename)
+      @lines = File.read(filename).split("\n").map do |line|
+        Line.new(line)
+      end
+    end
+
+    def line
+      lines[i]
+    end
+
+    def next_line
+      @i = (i + 1) % length
+    end
+
+    def previous_line
+      @i = (i - 1) % length
+    end
+
+    private
+
+    def_delegator :lines, :length
+
+    def i
+      @i ||= 0
+    end
+  end
+end

data/lib/tagline/screen_printer.rb

@@ -0,0 +1,26 @@
+module Tagline
+  module ScreenPrinter
+    class << self
+      def print_screen(line)
+        system('clear') || system('cls')
+
+        puts '********** Tagline *************'
+        puts "********************************\n\n"
+        puts ' * Press UP to see previous'
+        puts ' * Press DOWN to see next'
+        Tagline.tags.each do |tag, chord|
+          puts " * Press #{chord.chr.inspect} to toggle #{tag}"
+        end
+        puts ' * Press "n" to toggle next_on_tag'
+        puts ' * Press CTRL+X to exit'
+
+        puts "\nTags: "
+        Tagline.tags.keys.each do |tag|
+          puts "  #{tag}: #{line[tag]}"
+        end
+
+        print "\n=> #{line.text}"
+      end
+    end
+  end
+end

data/lib/tagline/tag_storer.rb

@@ -0,0 +1,43 @@
+module Tagline
+  class TagStorer
+    def initialize(filename, lines)
+      @filename, @lines = filename, lines
+    end
+
+    def retrieve_stored_tags
+      tag_names.each do |tag|
+        next unless File.exist?(tag_filename(tag))
+        tagged_lines = File.read(tag_filename(tag)).split("\n")
+        lines.each { |line| line[tag] = tagged_lines.include?(line.text) }
+      end
+    end
+
+    def save_tags
+      tag_names.each do |tag|
+        tagged_lines = lines.select { |line| line[tag] }.map(&:text)
+        next if tagged_lines.empty?
+        File.write(tag_filename(tag), tagged_lines.join("\n"))
+      end
+    end
+
+    private
+
+    attr_reader :filename, :lines
+
+    def tag_names
+      @tag_names ||= Tagline.tags.keys
+    end
+
+    def file_ext
+      @file_ext ||= File.extname(filename)
+    end
+
+    def file_without_ext
+      @file_without_ext ||= filename.chomp(file_ext)
+    end
+
+    def tag_filename(tag)
+      "#{file_without_ext}_#{tag}#{file_ext}"
+    end
+  end
+end

data/lib/tagline/tagger.rb

@@ -0,0 +1,39 @@
+require 'tagline/character_reader'
+require 'tagline/line_manager'
+require 'tagline/screen_printer'
+require 'tagline/tag_storer'
+
+module Tagline
+  class Tagger < CharacterReader
+    extend Forwardable
+
+    def initialize(filename)
+      @filename = filename
+      @line_manager = LineManager.new(filename)
+      @tag_storer = TagStorer.new(filename, lines)
+      retrieve_stored_tags
+    end
+
+    define_method(:before_loop) { print_screen }
+    define_method(:up_key) { previous_line; print_screen }
+    define_method(:down_key) { next_line; print_screen }
+    define_method(:n_key) { Tagline.next_on_tag = !Tagline.next_on_tag }
+    define_method(:after_loop) { save_tags }
+
+    def tag(chord)
+      tag = Tagline.tags.invert[chord]
+      return unless tag
+      toggle(tag)
+      next_line if Tagline.next_on_tag
+      print_screen
+    end
+
+    private
+
+    attr_reader :filename, :line_manager, :tag_storer
+    def_delegators :line_manager, :lines, :line, :next_line, :previous_line
+    def_delegator :line, :toggle
+    def_delegators :tag_storer, :retrieve_stored_tags, :save_tags
+    define_method(:print_screen) { ScreenPrinter.print_screen(line) }
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: tagline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.21
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.21
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: 
+email: mushishi78@gmail.com
+executables:
+- tagline
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/tagline
+- lib/tagline.rb
+- lib/tagline/character_reader.rb
+- lib/tagline/line.rb
+- lib/tagline/line_manager.rb
+- lib/tagline/screen_printer.rb
+- lib/tagline/tag_storer.rb
+- lib/tagline/tagger.rb
+homepage: 
+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: Simple command line tool for tagging lines of text
+test_files: []