syclink 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42124dedde2e500e40f48c650c8a785f4b0cbf1b
+  data.tar.gz: a29891c66efb0c567db21fcbd5b2d555df36e282
+SHA512:
+  metadata.gz: 1d3cfd10b1c918ff281e7cbe41c03ed1ce4856bf7427c4d09b40f137492be568327e763b3e0a168c99f13f8054147697547892f8c834c7f93495d23bad6b0b0b
+  data.tar.gz: 7d14080d1fb40568bd6c0c4e8f79b3ac4dcd6d0eb8ef327a595b2b25de45ef934b1a453b2ea7a9a7b1aab115ec3c4721541b9e40d078667feccd6773723350c8

data/.gitignore

@@ -0,0 +1,2 @@
+templates/example.html
+.sass-cache

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    syclink (0.0.1)
+      gli (= 2.13.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    gli (2.13.1)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sass (3.4.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  sass
+  syclink!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 sugaryourcoffee
+
+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,191 @@
+syclink
+=======
+_syclink_ is a comand line application to create a website with a link 
+collection. _syclink_ allows to add, update and delete links.
+
+Installation
+============
+The application is installed with _RubyGems_
+
+    $ gem install syclink
+
+Command Line Interface
+======================
+_syclink_ comes with a default website template and a CSS file. This can be
+adjusted to your convenience.
+
+Templates
+---------
+The templates are located in ~/.syc/syclink/templates and can be adjusted or
+completely replaced.
+
+Command Line
+------------
+Following list comprises the commands available
+
+_Website commands_
+* website show    - show all websites or search for websites
+* website remove  - Remove website
+* website create  - Create a HTML representation of the website
+
+_Link commands_
+* add    - Add a link
+* file   - Add links from a file
+* update - Update a link
+* delete - Delete a link 
+* list   - List all links with an optional filter
+* find   - Find links based on a search string
+
+Commands
+========
+Following the commands and how to use them is explained based on examples.
+
+Create a website
+----------------
+A website is send to syclink with the global `-w` flag. If the website does not
+exist yet the user is asked whether to create it and whether to set it as the
+default website. This is done with commands that require a website to operate
+on.
+
+    $ syclink -w my-new-website add "http://example.com"
+
+Before the command `add` is executed the website is created. In this 
+case a website called 'my-new-website' is created in the default directory at
+`~/.syc/syclink/websites/my-new-website.website
+
+Commands that require a website are `add`, `update`, `delete`, `list`, `find`
+and `website create`.
+
+If no website is specified the default website is used.
+
+Add a link
+----------
+A link may have a title, a description and a tag. Title, description and tag
+are optional but a link obviously has to be provided. If no title is given the
+link is used as the title.
+  
+    $ syclink add --title "Test page" --tag TEST \
+                  --description 'For testing purposes' http://example.com 
+
+It is also possible to add links from a file
+
+    $ syclink file file-with-links
+
+Update a link
+-------------
+To update a link the URL has to be specified. If more than one link has the 
+same URL only the first link is updated.
+
+    $ syclink update --title "Example" http://example.com 
+
+Remove a Link
+-------------
+To remove one or more links the URLs have to be provided.
+
+    $ syclink delete http://example.com,http://challenge.com
+
+List links
+----------
+Links can be selected based on a filter. If no filter is given all links are
+listed. It is possible to specify the columns to print. Possible columns are
+`url`, `name`, `description` and `tag`.
+
+    $ syclink list --tag TEST --columns 'url,description'
+
+    url                | description
+    -------------------+---------------------
+    http://example.com | For testing purposes
+
+Find links
+----------
+It is also possible to search for links based on a search string. The find
+command searches all attributes of the links and is searching for the occurance
+of the search string within the attributes. So the search is not list only 
+exact matches.
+
+    $ syclink find --columns 'url,tag' 'example' 
+
+    url                | tag
+    -------------------+-----
+    http://example.com | TEST
+
+List websites
+-------------
+The websites are saved to `~/.syc/syclink/websites/` and the html 
+representations are saved to `~/.syc/syclink/html/`. When listing websites
+both _webstites_ and _html_ files are listed.
+
+The following command will list all websites
+
+    $ syclink website list
+
+To list websites based on a search string the search string has to be send to
+the list command
+
+    $ syclink website list "example"
+
+If the `--exact` switch is given the command is only listing exact matches of
+the search string
+
+    $ syclink website list -e "http://example.com"
+
+Remove websites
+---------------
+Websites and their html representations can be deleted based on a filter string.
+To delete all websites and respective html representation the filter string
+'\*' can be provided
+
+    $ syclink website remove "*"
+
+    About to delete:
+
+    Websites
+    --------
+    /home/user/.syc/syclink/website/example.website
+
+    HTML-Files
+    ----------
+    /home/user/.syc/syclink/html/example.html
+
+    Delete websites and corresponding html files (y/n)? 
+
+Other exmamples of filter strings are `*mple` which will find `example` as well
+as `ex*`.
+
+Make a html representation of the website
+-----------------------------------------
+The ultimate command is `website create` which will create the html
+representation of the website.
+
+The html file is created based on an erb file located in 
+`~/.syc/syclink/templates/syclink.html.erb`. This can be adjusted to your
+convenience. The methods that can be used can be looked up in
+`lib/syctask/website.rb`.
+
+The html file will search for a css file in the directory `stylesheets` which
+is relative to the html file. The stylesheet is named `styles.css`. It is 
+possible to change it or replace it entirely. If the stylesheet's name is
+changed this also has to be done in `~/.syc/syclink/templates/syclink.html.erb`.
+
+There is also a _scss_ file which needs to be compiled to _css_ with _sass_
+like so
+
+    $ sass ~/.syc/syclink/html/stylesheets/styles.css.scss:\
+      ~/.syc/syclink/html/stylesheets/styles.css
+
+Warning: If the _css_ file has been changed all changes will be overridden by
+_sass_.
+
+Workflow
+========
+To create a website the steps are as follows
+
+* add links to a website
+* create the html representation
+
+Following is showing the above sequence in commands
+
+    $ syclink -w example add "http://example.com" --tag EXAMPLE
+    $ syclink add "http://github.com" --tag DEVELOPMENT
+    $ syclink website create
+

data/README.rdoc

@@ -0,0 +1,9 @@
+= syclink
+
+syclink can be used to create link list and turn them into an html 
+representation.
+
+Detailed information about the usage can be found at link:README.md 
+
+:include:syclink.rdoc
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rubygems/package_task'
+spec = eval(File.read('syclink.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end

data/bin/syclink

@@ -0,0 +1,290 @@
+#!/usr/bin/env ruby
+require 'gli'
+begin # XXX: Remove this begin/rescue before distributing your app
+require 'syclink'
+rescue LoadError
+  STDERR.puts "In development, you need to use `bundle exec bin/syclink` to run your app"
+  STDERR.puts "At install-time, RubyGems will make sure lib, etc. are in the load path"
+  STDERR.puts "Feel free to remove this message from bin/syclink now"
+  exit 64
+end
+
+include GLI::App
+include SycLink::Infrastructure
+include SycLink::Formatter
+
+# Commands that need to have a website and a designer object
+WEBSITE_COMMANDS = [ :create, :add, :file, :update, :delete, :list, :find ]
+
+# syclink's configuration directory
+syclink_directory             = File.expand_path("~/.syc/syclink")
+# syclink's configuration file
+syclink_file                  = File.join(syclink_directory, "syclink.rc")
+# syclink's template directory
+syclink_template_directory    = File.join(syclink_directory, "templates/")
+# syclink's html template"
+syclink_html_template         = File.join(syclink_template_directory, 
+                                          "syclink.html.erb")
+# syclink's website directory
+syclink_website_directory     = File.join(syclink_directory, "website/")
+# syclink's html directory
+syclink_html_directory        = File.join(syclink_directory, "html/")
+# syclink's stylesheet directory
+syclink_stylesheets_directory = File.join(syclink_html_directory, 
+                                          "stylesheets/")
+
+create_directory_if_missing(syclink_directory)
+
+create_directory_if_missing(syclink_template_directory)
+copy_file_if_missing(File.join(File.dirname(__FILE__), 
+                               '../templates/syclink.html.erb'),
+                     syclink_template_directory)
+
+create_directory_if_missing(syclink_website_directory)
+
+create_directory_if_missing(syclink_html_directory)
+
+create_directory_if_missing(syclink_stylesheets_directory)
+copy_file_if_missing(File.join(File.dirname(__FILE__), 
+                               '../templates/stylesheets/style.css'), 
+                     syclink_stylesheets_directory)
+copy_file_if_missing(File.join(File.dirname(__FILE__), 
+                               '../templates/stylesheets/style.css.scss'),
+                     syclink_stylesheets_directory)
+
+config = load_config(syclink_file)
+
+program_desc 'Create a link list and display it as an html page'
+
+version SycLink::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'Website to operate on'
+arg_name 'WEBSITE'
+flag [:w,:website]
+
+desc 'Add a link to the website'
+arg_name 'URL'
+command :add do |c|
+
+  c.desc 'Name of the link'
+  c.arg_name 'NAME'
+  c.flag [:n, :name]
+
+  c.desc 'Description of the link'
+  c.arg_name 'DESCRIPTION'
+  c.flag [:d, :description]
+
+  c.desc 'Tag the link is associated to'
+  c.arg_name 'TAG'
+  c.flag [:t, :tag]
+
+  c.action do |global_options,options,args|
+
+    @designer.add_link(args[0], options)
+
+  end
+end
+
+desc 'Add links from a file to the website'
+arg_name 'FILE'
+command :file do |c|
+
+  c.action do |global_options,options,args|
+
+    @designer.add_links_from_file(args[0])
+
+  end
+end
+
+desc 'Update a link'
+arg_name 'URL'
+command :update do |c|
+
+  c.desc 'Name of the link'
+  c.arg_name 'NAME'
+  c.flag [:n, :name]
+
+  c.desc 'Description of the link'
+  c.arg_name 'DESCRIPTION'
+  c.flag [:d, :description]
+
+  c.desc 'Tag the link is associated to'
+  c.arg_name 'TAG'
+  c.flag [:t, :tag]
+
+  c.action do |global_options,options,args|
+
+    @designer.update_link(args[0], options)
+
+  end
+end
+
+desc 'Find a link'
+arg_name 'FIND_STRING'
+command :find do |c|
+
+  c.desc 'Table columns to print'
+  c.default_value 'url, name, description, tag'
+  c.arg_name 'URL, NAME, DESCRIPTION, TAG'
+  c.flag [:c, :columns]
+
+  c.action do |global_options,options,args|
+
+    print_links(@designer.find_links(args[0].downcase), options[:c])
+
+  end
+end
+
+desc 'Remove one or more links'
+arg_name 'URL[URL,URL]'
+command :delete do |c|
+  c.action do |global_options,options,args|
+    @designer.remove_links(args)
+  end
+end
+
+desc 'List and optionally filter links'
+command :list do |c|
+
+  c.desc 'Link\'s URL'
+  c.arg_name 'URL'
+  c.flag [:u, :url]
+
+  c.desc 'Name of the link'
+  c.arg_name 'NAME'
+  c.flag [:n, :name]
+
+  c.desc 'Description of the link'
+  c.arg_name 'DESCRIPTION'
+  c.flag [:d, :description]
+
+  c.desc 'Tag the link is associated to'
+  c.arg_name 'TAG'
+  c.flag [:t, :tag]
+
+  c.desc 'Table columns to print'
+  c.default_value 'url, name, description, tag'
+  c.arg_name 'URL, NAME, DESCRIPTION, TAG'
+  c.flag [:c, :columns]
+
+  c.action do |global_options,options,args|
+    
+    print_links(@designer.list_links(options), options[:c])
+
+  end
+end
+
+desc "Operate on websites"
+command :website do |c|
+  c.desc 'Show all websites or search for websites'
+  c.arg_name 'WEBSITE'
+  c.skips_pre
+  c.skips_post
+  c.command :show do |s|
+
+    s.desc 'Show only the exactly matching website'
+    s.switch [:e, :exact]
+
+    s.action do |global_options,options,args|
+      if options[:e]
+        puts Dir.glob(yaml_file(syclink_website_directory, args[0]))
+      else
+        puts Dir.glob(File.join(syclink_website_directory, "*.website"))
+      end
+    end
+  end
+
+  c.desc 'Remove one or more websites'
+  c.arg_name 'WEBSITE_PATTERN'
+  c.skips_pre
+  c.skips_post
+  c.command :remove do |s|
+    s.action do |global_options,options,args|
+      websites = Dir.glob(File.join(syclink_website_directory, 
+                                    "#{args[0]}.website"))
+      html_files = Dir.glob(File.join(syclink_html_directory, 
+                                      "#{args[0]}.html"))
+      puts "About to delete:"
+      puts; puts "Websites"
+      puts "--------"
+      puts websites
+      puts; puts "HTML-Files"
+      puts "----------"
+      puts html_files
+      puts; print "Delete websites and corresponding html files (y/n)? "
+      if STDIN.gets.chomp =~ /y/i
+        websites.each { |website| FileUtils.rm website }
+        html_files.each { |html_file| FileUtils.rm html_file }
+      end
+    end
+  end
+  
+  c.desc 'Create html representation of website'
+  c.command [:create] do |s|
+    s.action do |global_options,options,args|
+      @designer.create_website(syclink_html_directory, syclink_html_template)
+    end
+  end
+
+  c.default_command :create
+end
+
+pre do |global,command,options,args|
+  
+  if WEBSITE_COMMANDS.include?(command.name)
+    @designer = SycLink::Designer.new
+    global[:website] ||= config[:default_website]
+
+    if File.exists? yaml_file(syclink_website_directory, global[:website])
+      @designer.load_website(yaml_file(syclink_website_directory, 
+                                       global[:website]))
+    else
+      print "Website #{global[:website]} doesn't exist. Create it (y/n)? "
+      if STDIN.gets.chomp =~ /y/i 
+        puts; puts "Creating #{global[:website]}"
+        @designer.new_website(global[:website])
+      else
+        exit(0)
+      end
+
+      if (global[:website] != config[:default_website])
+        print "Want to make #{global[:website]} the default (y/n)? "
+        if STDIN.gets.chomp =~ /y/i
+          puts; puts "Making #{global[:website]} the default website"
+          File.open(syclink_file, 'w') do |f| 
+            YAML.dump({ default_website: global[:website] }, f) 
+          end
+        end
+      end
+      
+    end
+    
+  end
+
+  true
+end
+
+post do |global,command,options,args|
+  if WEBSITE_COMMANDS.include? command.name
+    @designer.save_website(syclink_website_directory)
+  end
+end
+
+on_error do |exception|
+  if exception.message == "exit"
+    false
+  else
+    true
+  end
+end
+
+def print_links(links, columns)
+  allowed_cols = %w{ url name description tag } 
+  cols = columns.delete(' ').downcase.split(',') & allowed_cols
+  SycLink::Formatter.table(links, cols)
+end
+
+exit run(ARGV)

data/doc/Gemfile.html

@@ -0,0 +1,109 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>Gemfile - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script src="./js/jquery.js"></script>
+<script src="./js/darkfish.js"></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="file">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="project-metadata">
+    <div id="fileindex-section" class="nav-section">
+  <h3>Pages</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./Gemfile.html">Gemfile</a>
+  
+    <li><a href="./Gemfile_lock.html">Gemfile.lock</a>
+  
+    <li><a href="./LICENSE.html">LICENSE</a>
+  
+    <li><a href="./README_md.html">README</a>
+  
+    <li><a href="./README_rdoc.html">README</a>
+  
+    <li><a href="./links_csv.html">links.csv</a>
+  
+    <li><a href="./setup_md.html">setup</a>
+  
+    <li><a href="./syclink_gemspec.html">syclink.gemspec</a>
+  
+    <li><a href="./syclink_rdoc.html">syclink</a>
+  
+    <li><a href="./templates/example_html.html">example.html</a>
+  
+    <li><a href="./templates/links.html">links</a>
+  
+    <li><a href="./templates/stylesheets/style_css.html">style.css</a>
+  
+    <li><a href="./templates/stylesheets/style_css_map.html">style.css.map</a>
+  
+    <li><a href="./templates/stylesheets/style_css_scss.html">style.css.scss</a>
+  
+    <li><a href="./templates/syc-link_html.html">syc-link.html</a>
+  
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-label="Page Gemfile">
+
+<p>source &#39;<a href="https://rubygems.org">rubygems.org</a>&#39; gemspec</p>
+</main>
+
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+