cliptic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee1235c23dbbbddeee63cc9ff70d7042bdb3384a4e350e801137641db2d5470a
+  data.tar.gz: e9703a205b9c334034d776138c299fa844e31852842ec6200d6c7618b48c885b
+SHA512:
+  metadata.gz: a7308fd566cea0d68c23c00a10e61fad9b18a091d3c733387417c8ded1c4dd22abc53e1a7381e9c8b205f353b58cf761e7e27bd762b24d8fa5d72964b5e12ba0
+  data.tar.gz: ede96821bb377c53524b5ecdc2df06552807bee236d22cf281bdb04d95ef75910f6749a5f3aa21ffaf0680b03fe2bc930e44ed4c82e89642a636331f40277db9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.md

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2021-07-08
+
+- Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    cliptic (0.1.0)
+      curb
+      curses
+      sqlite3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    curb (0.9.11)
+    curses (1.4.0)
+    rake (13.0.3)
+    sqlite3 (1.4.2)
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  cliptic!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Christian Welham
+
+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,195 @@
+# CLIptic
+
+![](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
+
+## 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
+- 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
+
+## Dependencies
+
+### System
+- Ruby
+- Ncurses
+- Curl
+
+### Gems
+- curb
+- curses
+- sqlite3
+
+## Installing
+
+### As a Gem
+- CLIptic is available as a Ruby Gem. To install, simply run:
+```bash
+gem install cliptic
+```
+### Manually
+- Or, to install manually:
+```bash
+git clone https://github.com/apexatoll/cliptic
+cd cliptic
+rake build install
+```
+
+## Running
+- To run cliptic after installation, simply run the command `cliptic` from within the terminal
+- When the program is first run it will ask the user whether they want cliptic to generate a default config file. This is located in `~/.config/cliptic/cliptic.rc`
+- If the screen is too small to display cliptic, please resize until the prompt disappears
+
+### Other Commands
+- There are other commands that can be run from the command line
+
+#### Today
+- The command `cliptic today` will play today's puzzle
+- This command can be followed with a negative number to play a puzzle n days before today
+- For example `cliptic today -2` will play the puzzle from the day before yesterday
+
+#### Resetting Progress
+- The command `cliptic reset` will allow the user to reset progress in cliptic.
+- The command can be followed with either `all`, `states`, `scores` or `recents`
+- `all` resets all progress
+- `states` resets all game progress
+- `scores` resets high scores
+- `recents` resets puzzle history
+
+## Main Menu
+- On the main menu there are several options 
+	* Play today's puzzle
+	* Show this week's progress
+	* Select a date manually
+	* Display recent puzzles
+	* Show high scores
+	* Exit cliptic
+
+### Menu Navigation
+| Command          | Action         |
+|------------------|----------------|
+| `j/DOWN`, `k/UP` | Move cursor    |
+| `q`              | Back/quit      |
+| `ENTER`          | Make selection |
+	
+## Solving Puzzles
+- By default, cliptic uses vim-like keybindings for navigation and text manipulation. There are plans to release more "accessible" keybindings in the future.
+- Text manipulation is modal akin to vim. Vim-users will be familiar with insert and normal modes
+- The currently focussed clue is displayed within the window at the bottom of the screen. If you are on a cell that is an intersection of two clues (ie an across and a down) you can swap between them using `TAB`
+
+### Game Modes
+- There are 2 game modes that can be played. These can be changed in the cliptic config file.
+1. *Auto_mark* = 1 (default)
+	- Each clue is marked once every cell is filled
+	- The clue will be highlighted green or red depending on whether the attempt is correct
+2. *Auto_mark* = 0
+	- No clues are marked automatically, similar to a paper crossword 
+	- Clues can be checked manually using the `^G` command
+
+### Global Commands
+
+| Command | Action                                                                                                 |
+|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `^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)                                       |
+| `^P`    | Pause game                                                                                             |
+
+### Navigation (Normal Mode)
+- There are several ways to navigate the cells of the cliptic grid in **NORMAL MODE**.
+
+| 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)                      |
+
+### Entering Text (Insert Mode)
+
+| Command     | Action                              |
+|-------------|-------------------------------------|
+| `a-z`       | Enter character to cell             |
+| `BACKSPACE` | Delete one character                |
+| `ESC`       | Exit insert mode. Enter normal mode |
+
+### 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                                        |
+| `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                                      |
+
+## Configuration
+- Cliptic settings can be added to the cliptic.rc file found at `~/.config/cliptic/cliptic.rc`
+
+### Interface
+- Affect how cliptic functions
+- Set using the format
+```
+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       |
+
+### Colours
+- Colours are numbered 1-16. 
+	* 0 is default terminal color
+	* 1-8 equates to your terminals 8 default colours. 
+	* 9-16 equate to same colours as the background and blank as the foreground
+- To set colour settings use the format
+```
+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      |
+
+## Feedback
+- Cliptic is still in development
+- If you have any feature requests or find any bugs please leave a new issue
+- Contributions welcome!
+
+*Dedicated to WES who passed on to me his love of crosswords*
+
+[1]: https://lovattspuzzles.com/online-puzzles-competitions/daily-cryptic-crossword/

data/Rakefile

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

data/bin/cliptic

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/cliptic.rb"
+
+Cliptic::Terminal::Command.run

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "cliptic"
+
+# 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(__FILE__)

data/bin/setup

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

data/cliptic.gemspec

@@ -0,0 +1,25 @@
+require_relative "lib/cliptic/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "cliptic"
+  spec.version = Cliptic::VERSION
+  spec.authors = ["Christian Welham"]
+  spec.email = ["welhamm@gmail.com"]
+  spec.summary = "Terminal-based cryptic crossword player"
+  spec.description = "A terminal user interface to fetch and play cryptic crosswords"
+  spec.homepage = "https://github.com/apexatoll/cliptic"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/apexatoll/cliptic"
+  spec.metadata["changelog_uri"] = "https://github.com/apexatoll/cliptic/CHANGELOG.md"
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "bin"
+  spec.executables << "cliptic"
+  spec.require_paths = ["lib"]
+  spec.add_dependency("curses", "~> 1.4.0")
+  spec.add_dependency("curb", "~> 0.9.11")
+  spec.add_dependency("sqlite3", "~> 1.4.2")
+end

data/lib/cliptic.rb

@@ -0,0 +1,53 @@
+module Cliptic
+  require 'cgi'
+  require 'curb'
+  require 'curses'
+  require 'date'
+  require 'fileutils'
+  require 'json'
+  require 'sqlite3'
+  require 'time'
+  class Screen
+    extend Curses
+    def self.setup
+      init_curses
+      set_colors if has_colors?
+      redraw
+    end
+    def self.init_curses
+      init_screen
+      raw
+      noecho
+      curs_set(0)
+    end
+    def self.set_colors
+      start_color
+      use_default_colors
+      1.upto(8) do |i|
+        init_pair(i, i, -1)
+        init_pair(i+8, 0, i)
+      end
+    end
+    def self.clear
+      stdscr.clear
+      stdscr.refresh
+    end
+    def self.too_small?
+      lines < 36 || cols < 61
+    end
+    def self.redraw(cb:nil)
+      Interface::Resizer.new.show if Screen.too_small?
+      Screen.clear
+      cb.call if cb
+    end
+  end
+  require_relative "cliptic/version"
+  require_relative "cliptic/terminal.rb"
+  require_relative "cliptic/lib.rb"
+  require_relative "cliptic/config.rb"
+  require_relative "cliptic/database.rb"
+  require_relative "cliptic/windows.rb"
+  require_relative "cliptic/interface.rb"
+  require_relative "cliptic/menus.rb"
+  require_relative "cliptic/main.rb"
+end

data/lib/cliptic/config.rb

@@ -0,0 +1,99 @@
+module Cliptic
+  module Config
+    Dir_Path  = "#{Dir.home}/.config/cliptic"
+    File_Path = "#{Dir_Path}/cliptic.rc"
+    class Default
+      def self.colors
+        {
+          box:8, grid:8, bar:16, logo_grid:8, 
+          logo_text:1, title:3, stats:2, active_num:3, 
+          num:8, block:8, I:15, N:12, correct:2, 
+          incorrect:1, meta:3, cluebox:8
+        }
+      end
+      def self.config
+        {
+          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
+      end
+      def set
+        cfg_file_exists? ? 
+          read_cfg : gen_cfg_menu.choose_opt
+        $config = make_bool($config)
+      end
+      private
+      def read_cfg
+        Reader.new.tap do |file|
+          cfg_file_keys.each do |dest, key|
+            dest.merge!(file.read(**key))
+          end
+        end
+      end
+      def cfg_file_keys
+        {
+          $colors => {key:"hi"},
+          $config => {key:"set"}
+        }
+      end
+      def 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
+        Cliptic::Interface::Yes_No_Menu.new(
+          yes:->{Generator.new.write},
+          title:"Generate a config file?"
+        )
+      end
+    end
+    class Reader
+      attr_reader :lines
+      def initialize
+        @lines = File.read(File_Path).each_line.map.to_a
+      end
+      def read(key:)
+        lines.grep(/^\s*#{key}/)
+          .map{|l| l.gsub(/^\s*#{key}\s+/, "")
+          .split(/\s+/)}
+          .map{|k, v| [k.to_sym, v.to_i]}
+          .to_h
+      end
+    end
+    class Generator
+      def write
+        FileUtils.mkdir_p(Dir_Path) unless cfg_dir_exists
+        File.write(File_Path, make_file)
+      end
+      private
+      def cfg_dir_exists
+        Dir.exist?(Dir_Path)
+      end
+      def file_data
+        {
+          "Colour Settings" => {
+            cmd:"hi", values:Default.colors
+          },
+          "Interface Settings" => {
+            cmd:"set", values:Default.config
+          }
+        }
+      end
+      def make_file
+        file_data.map do |comment, data|
+          ["//#{comment}"] + data[:values].map{|k, v| "#{data[:cmd]} #{k} #{v}"} + ["\n"]
+        end.join("\n")
+      end
+    end
+  end
+end