cliptic 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a111afd996822491916a4b3a30a23ec14f8f42a0c5672bbb7bfc9b30dd01b5b7
-  data.tar.gz: 96179d16fb507ef749d2557ae6f63be9f2dfed9f27e07b20090dd691218bfaf1
+  metadata.gz: bed7e4167bd109d3595030a840bfa5295f7fefea8306db6a8843e09feb5bf1c5
+  data.tar.gz: 76c18f65f31077f7611d37e94025a2133f272553291a0a1cda68eebb3428966a
 SHA512:
-  metadata.gz: eda2f04490818ecf91f1d6408e365a165f3b682965a7858e98c9af5b0ec9a167b544d712d51e198faa66944aa205804ce65aac6dc7df9c7ac1a2152848cd44db
-  data.tar.gz: 28fdc763822316d58390e9b51f478315e228a4690ed2a7908430897139f6757267a08aef9bd606549a9678b1e619b7f2922110aa44c1e78afd6a17881d37766d
+  metadata.gz: 26e80fd00217904ed0d081cf8a676c339e82d2c586667ebf8f47daa542fb9b3ec427b8b89bb4860b087b28f555624d03ccfa56fd1d9050bd28dfe4dcaff1968f
+  data.tar.gz: 8c29f4b0fa7ef0c25db0256854917de5b868f3068099588dc423c1aa4aa8f23715c7124d15e5175577b161cf0e2e0109a5587f049aaba6ad9e8960618cba79e7

data/CHANGELOG.md

@@ -5,3 +5,14 @@
 ## [0.1.1] - 2021-07-11
 
 - Minor change to fix screen setup bug
+
+## [0.1.2] - 2021-07-15
+
+### Bug Fixes
+- Screen setup/config file bug fix
+	* Previously screen resize prompt would not show if screen was too small due to inability to source default colours
+- Fix earliest date bug 
+- Center the resize prompt
+
+### Features
+- Add menu recolour feature

data/Gemfile

@@ -1,8 +1,5 @@
-# frozen_string_literal: true
-
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in cliptic.gemspec
 gemspec
 
 gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cliptic (0.1.0)
+    cliptic (0.1.2)
       curb (~> 0.9.11)
       curses (~> 1.4.0)
       sqlite3 (~> 1.4.2)

data/README.md

@@ -1,20 +1,32 @@
-# CLIptic
+# `cliptic`: Crosswords in your Terminal
 
 ![](https://github.com/apexatoll/cliptic-files/blob/master/demo.gif)
 
+
 - A command-line interface for downloading and playing cryptic crosswords from within the terminal. 
 - Puzzles are sourced from the free crosswords uploaded daily to [Lovatt's][1]. 
-- CLIptic is written in Ruby using the ncurses library
+- cliptic is written in Ruby using the ncurses library
+
+## New to 0.1.2
+
+### Bug Fixes
+- Screen setup/config file bug fix
+	* Previously screen resize prompt would not show if screen was too small due to inability to source default colours
+- Fix earliest date bug (thank you `samtell21` for pointing this out)
+- Center the resize prompt
+
+### Features
+- Add menu recolour feature
 
 ## Features
 - VIM-like keybindings
 - Puzzles scraped daily from Lovatt's. Puzzles are cached locally to prevent excessive requests
 - Progress can be saved to continue puzzles at a later time
-- Time taken to complete the puzzle is logged on completion of puzzle. High scores can be viewed within CLIptic
+- Time taken to complete the puzzle is logged on completion of puzzle. High scores can be viewed within cliptic
 - Track progress for puzzles released in the last week
 - Puzzle history is tracked, making it easy to pick up recently played puzzles
 - Select puzzles to play by date manually (puzzles are available for up to 9 months from release)
-- Customisation of CLIptic's appearance
+- Customisation of cliptic's appearance
 
 ## Dependencies
 
@@ -31,7 +43,7 @@
 ## Installing
 
 ### As a Gem
-- CLIptic is available as a Ruby Gem. To install, simply run:
+- cliptic is available as a Ruby Gem. To install, simply run:
 ```bash
 gem install cliptic
 ```
@@ -97,26 +109,26 @@ rake build install
 ### Global Commands
 
 | Command | Action                                                                                                 |
-|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `^S`    | Save current progress (note that progress is saved when exiting puzzles by default)                 |
+|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `^S`    | Save current progress (note that progress is saved when exiting puzzles by default)                |
 | `^R`    | Reveals solution for focussed clue (note that this forfeits adding this puzzle to high scores) |
 | `^C`    | Exit puzzle                                                                                            |
 | `^E`    | Resets timer and progress for puzzle                                                                   |
-| `^G`    | Mark current progress (only relevant if auto_mark is set to 0)                                       |
+| `^G`    | Mark current progress (only relevant if auto_mark is set to 0)                                         |
 | `^P`    | Pause game                                                                                             |
 
 ### Navigation (Normal Mode)
 - There are several ways to navigate the cells of the cliptic grid in **NORMAL MODE**.
 
-| Command            | Action                                                             |
-|--------------------|----------------------------------------------------------------------------------------------------------------------------------|
+| Command            | Action                                                         |
+|--------------------|----------------------------------------------------------------|
 | `h`, `j`, `k`, `l` | Move cursor left, up, down, right. Arrow keys can also be used |
-| `(n)w`             | Move to (nth) next unsolved clue                                   |
-| `(n)b`             | Move to (nth) previous unsolved clue                               |
-| `e`                | Move to end of clue                                                |
-| `<clue number>g`   | Move to clue by number                                             |
-| `<cell number>G`   | Move to cell by number (not 0 indexed                              |
-| `TAB`              | Swap from across to down clue (or vice versa)                      |
+| `(n)w`             | Move to (nth) next unsolved clue                               |
+| `(n)b`             | Move to (nth) previous unsolved clue                           |
+| `e`                | Move to end of clue                                            |
+| `<clue number>g`   | Move to clue by number                                         |
+| `<cell number>G`   | Move to cell by number (not 0 indexed                          |
+| `TAB`              | Swap from across to down clue (or vice versa)                  |
 
 ### Entering Text (Insert Mode)
 
@@ -128,15 +140,15 @@ rake build install
 
 ### Normal Mode
 
-| Command   | Action                                                                      |
-|-----------|-----------------------------------------------------------------------------------------|
-| `I`       | Move to the start of the clue and enter insert mode                         |
-| `a`       | Advance one cell and enter insert mode                                      |
-| `c(obj)`  | calls d(obj) then enters insert mode                                        |
+| Command   | Action                                                                         |
+|-----------|-----------------------------------------------------------------------------------------------------|
+| `I`       | Move to the start of the clue and enter insert mode                            |
+| `a`       | Advance one cell and enter insert mode                                         |
+| `c(obj)`  | calls d(obj) then enters insert mode                                           |
 | `d(obj)`  | delete the object provided after d (may be w for word or l for character) |
-| `i`       | Enter insert mode                                                           |
-| `r(char)` | Replaces the character under the cursor with `char`                         |
-| `x`       | deletes the character under the cursor                                      |
+| `i`       | Enter insert mode                                                              |
+| `r(char)` | Replaces the character under the cursor with `char`                            |
+| `x`       | deletes the character under the cursor                                         |
 
 ## Configuration
 - Cliptic settings can be added to the cliptic.rc file found at `~/.config/cliptic/cliptic.rc`
@@ -150,11 +162,11 @@ set <setting> <0/1>
 
 #### Settable Items
 
-| Item         | Description                    | Default |
-|--------------|--------------------------------|---------|
-| auto_advance | Move to next clue after solve  | 1       |
-| auto_mark    | Mark clues as they are entered | 1       |
-| auto_save    | Save progress on exit          | 1       |
+| Item           | Description                    | Default |
+|----------------|--------------------------------|---------|
+| `auto_advance` | Move to next clue after solve  | 1       |
+| `auto_mark`    | Mark clues as they are entered | 1       |
+| `auto_save`      | Save progress on exit          | 1       |
 
 ### Colours
 - Colours are numbered 1-16. 
@@ -168,22 +180,24 @@ hi <obj> <colour>
 	
 #### Settable Items
 
-| Item       | Description                | Default |
-|------------|----------------------------|---------|
-| active_num | Grid number of active clue | 3       |
-| bar        | Top and bottom bars        | 16      |
-| block      | Grid blocks                | 8       |
-| box        | Box outlines               | 8       |
-| grid       | cliptic grids              | 8       |
-| incorrect  | Incorrect clue attempt     | 1       |
-| correct    | Correct clue attempt       | 2       |
-| prompt     | Menu prompt                | 3       |
-| default    | Default text color         | 0       |
-| meta       | Clue box metadata          | 3       |
-| num        | Inactive grid numbers      | 8       |
-| logo_text  | Logo text color            | 3       |
-| I          | Insert mode prompt         | 15      |
-| N          | Normal mode prompt         | 12      |
+| Item            | Description                | Default |
+|-----------------|----------------------------|---------|
+| `active_num`    | Grid number of active clue | 3       |
+| `bar`           | Top and bottom bars        | 16      |
+| `block`         | Grid blocks                | 8       |
+| `box`           | Box outlines               | 8       |
+| `grid`          | cliptic grids              | 8       |
+| `incorrect`     | Incorrect clue attempt     | 1       |
+| `correct`       | Correct clue attempt       | 2       |
+| `prompt`        | Menu prompt                | 3       |
+| `default`       | Default text color         | 0       |
+| `meta`          | Clue box metadata          | 3       |
+| `num`           | Inactive grid numbers      | 8       |
+| `logo_text`     | Logo text color            | 3       |
+| `I`             | Insert mode prompt         | 15      |
+| `N`             | Normal mode prompt         | 12      |
+| `menu_active`   | Active menu option         | 15      |
+| `menu_inactive` | Inactive menu option       | 0       |
 
 ## Feedback
 - Cliptic is still in development

data/Rakefile

@@ -1,4 +1,2 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
 task default: %i[]

data/lib/cliptic/config.rb

@@ -3,57 +3,55 @@ module Cliptic
     Dir_Path  = "#{Dir.home}/.config/cliptic"
     File_Path = "#{Dir_Path}/cliptic.rc"
     class Default
+      def self.set
+        $colors = colors
+        $config = make_bool(config)
+      end
+      private
       def self.colors
         {
           box:8, grid:8, bar:16, logo_grid:8, 
-          logo_text:1, title:3, stats:2, active_num:3, 
+          logo_text:3, title:6, stats:6, active_num:3, 
           num:8, block:8, I:15, N:12, correct:2, 
-          incorrect:1, meta:3, cluebox:8
+          incorrect:1, meta:3, cluebox:8, 
+          menu_active:15, menu_inactive:0
         }
       end
       def self.config
         {
-          auto_advance:1,
-          auto_mark:1,
-          auto_save:1
+          auto_advance:1, auto_mark:1, auto_save:1
         }
       end
-    end
-    class Setter
-      attr_reader :colors, :config
-      def initialize
-        $colors = Default.colors
-        $config = Default.config
+      def self.make_bool(hash)
+        hash.each{|k, v| hash[k] = v == 1 }
       end
-      def set
-        cfg_file_exists? ? 
-          read_cfg : gen_cfg_menu.choose_opt
-        $config = make_bool($config)
+    end
+    class Custom < Default 
+      def self.set
+        cfg_file_exists? ? read_cfg : gen_cfg_menu.choose_opt
       end
       private
-      def read_cfg
+      def self.read_cfg
         Reader.new.tap do |file|
-          cfg_file_keys.each do |dest, key|
+          key_map.each do |dest, key|
             dest.merge!(file.read(**key))
           end
         end
+        make_bool($config)
       end
-      def cfg_file_keys
+      def self.key_map
         {
           $colors => {key:"hi"},
           $config => {key:"set"}
         }
       end
-      def cfg_file_exists?
+      def self.cfg_file_exists?
         File.exist?(File_Path)
       end
-      def make_bool(hash)
-        hash.map{|k, v| [k, v == 1]}.to_h
-      end
-      def gen_cfg_menu
+      def self.gen_cfg_menu
         Cliptic::Interface::Yes_No_Menu.new(
           yes:->{Generator.new.write},
-          title:"Generate a config file?"
+          title:"Generate config file?"
         )
       end
     end

data/lib/cliptic/interface.rb

@@ -97,6 +97,9 @@ module Cliptic
       def prompt
         "Screen too small. Increase screen size to run cliptic."
       end
+      def line
+        (Curses.lines-8)/2
+      end
     end
     class Selector < Windows::Window
       attr_reader :opts, :ctrls, :run, :tick

data/lib/cliptic/menus.rb

@@ -16,8 +16,9 @@ module Cliptic
       end
     end
     class Select_Date < Interface::Menu_With_Stats
-      attr_reader :opts
+      attr_reader :opts, :earliest_date
       def initialize
+        @earliest_date = (Date.today << 9) + 1
         set_date(date:Date.today)
         super(height:7, sel:Interface::Date_Selector)
       end
@@ -88,14 +89,14 @@ module Cliptic
         Date.new(date[2], date[1]+1, 1)-1
       end
       def check_in_range
-        set_date(date:Date.today) if date_late?
-        set_date(date:Date.today << 9) if date_early?
+        set_date(date:Date.today)    if date_late?
+        set_date(date:earliest_date) if date_early?
       end
       def date_late?
         stat_date > Date.today
       end
       def date_early?
-        stat_date < Date.today<<9
+        stat_date < earliest_date
       end
     end
     class This_Week < Interface::Menu_With_Stats

data/lib/cliptic/terminal.rb

@@ -10,8 +10,9 @@ module Cliptic
       end
       private
       def self.setup
+        Config::Default.set
         Screen.setup
-        Config::Setter.new.set
+        Config::Custom.set
         at_exit{close}
       end
       def self.main_menu

data/lib/cliptic/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Cliptic
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/cliptic/windows.rb

@@ -82,6 +82,12 @@ module Cliptic
       def move(line:nil, col:nil)
         super(*center_pos(y:y, x:x, line:line, col:col))
       end
+      def standout
+        color($colors[:menu_active])
+      end
+      def standend
+        color($colors[:menu_inactive])
+      end
       private
       def wrap_dims(y:, x:)
         [y, x].zip(total_dims)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliptic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Christian Welham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-11 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses