jareditor 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7c8e3df3bf5baf5322111c11ee4c374bd466cd0
-  data.tar.gz: 658397e3d424c784a722faebe74a5821ac51dbbb
+  metadata.gz: 74ddec2036fa178c8a8afd9c7a113860c1efdc61
+  data.tar.gz: f70dc7ca5473dfbc93eb0efc88a1e3e93cd16edf
 SHA512:
-  metadata.gz: 0122f6e42df9b6696b1de598c6b182047d05948b06dffa8833aac7eaf4f18df68d56325a64c468f597e9fab69650c16af797a1cc39477d1dabd97c283c3fd2ba
-  data.tar.gz: c592be92a95219df7f0506c143f40f022382170cf348fe2da81fd002d61d0bd80289fa8b204032b7e705ca5650fcdd8d08b76fccc639233b3e05850be2d2e217
+  metadata.gz: ac436f1d41c626009ed5d0c3d362aad486c2850a8aeacdea326aaaa197cb75a7504d254275f3fd739161746145645b45304de652f4bffc772d4e64cefe7b3312
+  data.tar.gz: 7ad0b45f39fa8ad57c34273920ff1f25a98013713ebbe524f9dd7dc535a4a71a590feb7d2a2dea54568759fd3fa7fc6c406fff8ea4bc337dfe0c5954290d75af

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor

data/.rubocop.yml

@@ -0,0 +1,149 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+# Relaxed.Ruby.Style
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Style/DotPosition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespacebeforeblockbraces
+
+Style/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/README.md

@@ -4,7 +4,9 @@ The jerk's text editor.
 
 ## Installation
 
-    $ gem install jareditor
+```sh
+$ gem install jareditor
+```
 
 ## Usage
 
@@ -12,15 +14,9 @@ Don't.
 
 ## 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.
+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).
+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).
 
 ## Roadmap
 
@@ -31,8 +27,4 @@ git commits and tags, and push the `.gem` file to
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/jarednorman/jared. 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.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/jarednorman/jared. 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.

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :spec
+task default: :test

data/bin/console

@@ -1,14 +1,5 @@
 #!/usr/bin/env ruby
-
 require "bundler/setup"
-require "jar_ed"
-
-# 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
+require "jared"
+require "pry"
+Pry.start

data/lib/jared.rb

@@ -1,27 +1,20 @@
 require "curses"
+require "logger"
 require "jared/version"
 require "jared/pane"
+require "jared/file_view"
 require "jared/buffer"
 
 module JarEd
   class << self
     def start(args)
-      buffer = Buffer.new File.open(args[0], "r")
-      pane.buffer = buffer
+      buffer = Buffer.new(args[0])
+      pane = Pane.new
+      pane.view = FileView.new buffer
 
       take_input do |char|
-        case char
-        when "h"
-          buffer.cursor(0, -1)
-        when "j"
-          buffer.cursor(1, 0)
-        when "k"
-          buffer.cursor(-1, 0)
-        when "l"
-          buffer.cursor(0, 1)
-        when "\e"
-          break
-        end
+        # FIXME: This should normalize incoming escape sequences and such.
+        pane.send_input char
         pane.refresh(window)
       end
     end
@@ -30,14 +23,31 @@ module JarEd
       "Jared Norman"
     end
 
+    def logger
+      @logger ||=
+        begin
+          log_directory_path = File.join(jared_folder_path, "logs")
+          FileUtils.mkdir_p log_directory_path
+          log_file_path = File.join(log_directory_path, "jared.log")
+          logger = Logger.new(log_file_path, 10)
+          logger.level = Logger::DEBUG
+          logger
+        end
+    end
+
     private
 
-    def pane
-      @pane ||= Pane.new
+    def jared_folder_path
+      @jared_folder_path ||=
+        begin
+          path = File.join(Dir.home, ".jared")
+          FileUtils.mkdir_p(path)
+          path
+        end
     end
 
     def window
-      @window ||= Curses::Window.new(Curses.lines, Curses.cols, 0, 0)
+      @window ||= Curses::Window.new(0, 0, 0, 0)
     end
 
     def take_input
@@ -51,7 +61,12 @@ module JarEd
         Curses.doupdate
 
         loop do
-          yield Curses.getch.chr
+          begin
+            yield Curses.getch.chr
+          rescue RangeError
+            yield nil
+          end
+
           Curses.doupdate
         end
       ensure

data/lib/jared/buffer.rb

@@ -1,24 +1,20 @@
+require 'jared/buffer_line'
+
 module JarEd
   class Buffer
-    attr_reader :window_position,
-                :cursor_row,
-                :cursor_column
-
-    def initialize(file)
-      @file = file
-      @window_position = 0
-      @cursor_row = 0
-      @cursor_column = 0
+    def initialize(filename)
+      @file = File.open(filename, "r")
     end
 
     def lines
-      @lines ||= file.each_line.to_a
+      @lines ||= file.each_line.to_a.map { |line| BufferLine.new(line) }
     end
 
-    # @todo Restrict cursor position to file/line length.
-    def cursor(rows, columns)
-      @cursor_row = [0, cursor_row + rows].max
-      @cursor_column = [0, cursor_column + columns].max
+    def wrapped_lines(width:, height:, offset:)
+      lines.
+        slice(offset, lines.length - 1).
+        flat_map { |line| line.wrap(width: width) }.
+        first(height)
     end
 
     private

data/lib/jared/buffer_line.rb

@@ -0,0 +1,25 @@
+module JarEd
+  class BufferLine
+    attr_reader :raw_text
+
+    def initialize(raw_text)
+      @raw_text = raw_text
+    end
+
+    def text
+      @text ||= raw_text.chomp
+    end
+
+    def blank?
+      text == ""
+    end
+
+    def wrap(width:)
+      if blank?
+        [""]
+      else
+        text.scan(/.{1,#{width}}/)
+      end
+    end
+  end
+end

data/lib/jared/file_view.rb

@@ -0,0 +1,108 @@
+require 'jared/screen'
+
+module JarEd
+  class FileView
+    attr_accessor :pane
+
+    def initialize(buffer)
+      @buffer = buffer
+      @row_offset = 0
+      @cursor_row = 0
+      @cursor_column = 0
+    end
+
+    # @todo Make this method not awful.
+    def to_screen
+      Screen.new(
+        cursor_column: screen_cursor_column,
+        cursor_row: screen_cursor_row,
+        lines: screen_lines
+      )
+    end
+
+    def send_input(input)
+      case input
+      when "h"
+        update_cursor(column: cursor_column - 1)
+      when "j"
+        update_cursor(row: cursor_row + 1)
+      when "k"
+        update_cursor(row: cursor_row - 1)
+      when "l"
+        update_cursor(column: cursor_column + 1)
+      end
+    end
+
+    private
+
+    attr_reader :buffer
+
+    attr_accessor :cursor_row,
+                  :cursor_column,
+                  :row_offset
+
+    def width
+      pane.width
+    end
+
+    def height
+      pane.height
+    end
+
+    def update_cursor(row: cursor_row, column: cursor_column)
+      row = [0, row].max
+      row = [row, buffer.lines.length - 1].min
+      @cursor_row = row
+
+      column = [0, column].max
+      column = [column, current_line.raw_text.length - 1].min
+      @cursor_column = column
+
+      if row < row_offset
+        self.row_offset = row
+      end
+
+      # FIXME: Can probably do this more efficiently.
+      # FIXME: This only fits the first row worth of the current line on the
+      # screen. The desired behaviour is that all the rows of the current line
+      # are fit on in this scenario.
+      while screen_cursor_row >= height
+        self.row_offset = row_offset + 1
+      end
+    end
+
+    def current_line
+      buffer.lines[cursor_row]
+    end
+
+    def screen_cursor_column
+      if cursor_column < width
+        cursor_column
+      else
+        cursor_column % width
+      end
+    end
+
+    def screen_cursor_row
+      buffer.lines.slice(row_offset, buffer.lines.length - 1).reduce(0) do |acc, line|
+        if line == current_line
+          if cursor_column < width
+            break acc
+          else
+            break acc + cursor_column / width
+          end
+        else
+          acc + line.wrap(width: width).length
+        end
+      end
+    end
+
+    def screen_lines
+      buffer.wrapped_lines(
+        offset: row_offset,
+        width: width,
+        height: height
+      )
+    end
+  end
+end

data/lib/jared/pane.rb

@@ -1,21 +1,49 @@
 module JarEd
   class Pane
-    attr_accessor :buffer
-
     def refresh(window)
-      window.setpos(0, 0)
-      draw_lines(window)
-      window.setpos(buffer.cursor_row, buffer.cursor_column)
+      screen = view.to_screen
+      validate!(screen)
+      window.clear
+      draw_screen(window, screen)
+      window.setpos(screen.cursor_row, screen.cursor_column)
       window.noutrefresh
     end
 
+    def send_input(char)
+      view.send_input(char)
+    end
+
+    def view=(view)
+      view.pane = self
+      @view = view
+    end
+
+    def width
+      Curses.cols
+    end
+
+    def height
+      Curses.lines
+    end
+
     private
 
-    def draw_lines(window)
-      buffer.lines.each do |line|
-        # line_height = line.scan(/.{1,#{Curses.cols}}/)
+    attr_reader :view
+
+    def draw_screen(window, screen)
+      screen.lines.each_with_index do |line, index|
+        window.setpos index, 0
         window.addstr line
       end
     end
+
+    # @todo Validate that the screen fits in the pane.
+    def validate!(screen)
+      screen.cursor_column >= 0 &&
+        screen.cursor_row >= 0 &&
+        screen.cursor_column < width &&
+        screen.cursor_row < height ||
+        raise("Invalid screen.")
+    end
   end
 end

data/lib/jared/screen.rb

@@ -0,0 +1,20 @@
+module JarEd
+  class Screen
+    attr_reader :lines, :cursor_column, :cursor_row
+
+    # @todo Rename these to cursor_row/column
+    def initialize(lines:, cursor_column:, cursor_row:)
+      @lines = lines
+      @cursor_column = cursor_column
+      @cursor_row = cursor_row
+    end
+
+    def width
+      lines.map(&:length).max
+    end
+
+    def height
+      lines.length
+    end
+  end
+end

data/lib/jared/version.rb

@@ -1,3 +1,3 @@
 module JarEd
-  VERSION = "2.0.0"
+  VERSION = "3.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jareditor
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jared Norman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-20 00:00:00.000000000 Z
+date: 2016-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -117,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -128,7 +129,10 @@ files:
 - jareditor.gemspec
 - lib/jared.rb
 - lib/jared/buffer.rb
+- lib/jared/buffer_line.rb
+- lib/jared/file_view.rb
 - lib/jared/pane.rb
+- lib/jared/screen.rb
 - lib/jared/version.rb
 homepage: https://github.com/jarednorman/jared
 licenses: []