comment_extractor 1.0.1

data/spec/assets/source_code/lua.lua

@@ -0,0 +1,34 @@
+--[-1-]Attribution-Share Alike 3.0 License, copyright (c) 2010 Pieter Hintjens, modified @alpaca-tc
+--[-2-]  Demonstrate identities as used by the request-reply pattern.  Run this
+--[-3-]  program by itself.  Note that the utility functions s_ are provided by
+--[-4-]  zhelpers.h.  It gets boring for everyone to keep repeating this code.
+--[-5-]
+--[-6-]  Author: Robert G. Jakabosky <bobby@sharedrealm.com>
+--[-7-]
+require"zmq"
+require"zhelpers"
+
+local context = zmq.init(1)
+
+local sink = context:socket(zmq.ROUTER)
+sink:bind("inproc://example")
+
+--[-16-]  First allow 0MQ to set the identity
+local anonymous = context:socket(zmq.REQ)
+anonymous:connect("inproc://example")
+anonymous:send("ROUTER uses a generated UUID")
+s_dump(sink)
+
+--[[[-22-]
+[-23-]
+]]
+local identified = context:socket(zmq.REQ) --[-25-]  Then set the identity ourselves
+identified:setopt(zmq.IDENTITY, "PEER2")
+identified:connect("inproc://example")
+identified:send("ROUTER socket uses REQ's socket identity")
+s_dump(sink)
+
+sink:close()
+anonymous:close()
+identified:close()
+context:term()

data/spec/assets/source_code/perl.pl

@@ -0,0 +1,36 @@
+
+=pod[-2-]
+[-3-]Attribution-Share Alike 3.0 License, copyright (c) 2010 Pieter Hintjens, modified @alpaca-tc
+[-4-]Hello World server
+[-5-]
+[-6-]Connects REP socket to tcp://*:5560
+[-7-]
+[-8-]Expects "Hello" from client, replies with "World"
+[-9-]
+[-10-]Author: Daisuke Maki (lestrrat)
+[-11-]Original version Author: Alexander D'Archangel (darksuji) <darksuji(at)gmail(dot)com>
+[-12-]
+=cut
+
+use strict;
+use warnings;
+use 5.10.0;
+
+use ZMQ::LibZMQ3;
+use ZMQ::Constants qw(ZMQ_REP);
+use zhelpers;
+
+my $context = zmq_init();
+
+#[-25-] Socket to talk to clients
+my $responder = zmq_socket($context, ZMQ_REP);
+zmq_connect($responder, 'tcp://localhost:5560');
+
+while (1) {
+    my $string = s_recv($responder); #[-30-] Wait for next request from client
+    say "Received request: [$string]";
+
+    sleep (1);
+
+    s_send($responder, 'World');
+}

data/spec/assets/source_code/php.php

@@ -0,0 +1,31 @@
+<?php
+/*[-2-]Attribution-Share Alike 3.0 License, copyright (c) 2010 Pieter Hintjens, modified @alpaca-tc
+[-3-]Lazy Pirate client
+[-4-]Use zmq_poll to do a safe request-reply
+[-5-]To run, start lpserver and then randomly kill/restart it
+[-6-]
+[-7-]@author Ian Barber <ian(dot)barber(at)gmail(dot)com>
+[-8-][-end-]*/
+
+define("REQUEST_TIMEOUT", 2500); //[-10-]  msecs, (> 1000!)
+define("REQUEST_RETRIES", 3); //[-11-]  Before we abandon
+
+function client_socket(ZMQContext $context)
+{
+    echo "I: connecting to server...", PHP_EOL;
+    $client = new ZMQSocket($context,ZMQ::SOCKET_REQ);
+    $client->connect("tcp://localhost:5555");
+
+    //[-19-]  Configure socket to not wait at close time
+    $client->setSockOpt(ZMQ::SOCKOPT_LINGER, 0);
+    /*[-21-] [-end-]*/
+
+    return $client;
+}
+
+$context = new ZMQContext();
+$client = client_socket($context);
+
+$sequence = 0;
+$retries_left = REQUEST_RETRIES;
+$read = $write = array();

data/spec/assets/source_code/python.py

@@ -0,0 +1,139 @@
+"""[-1-]Attribution-Share Alike 3.0 License, copyright (c) 2010 Pieter Hintjens, modified @alpaca-tc
+[-2-]=====================================================================
+[-3-]kvmsg - key-value message class for example applications
+[-4-]
+[-5-]Author: Min RK <benjaminrk@gmail.com>
+[-6-]
+"""
+
+import struct #[-9-] for packing integers
+import sys
+from uuid import uuid4
+
+import zmq
+import zmq.utils.jsonapi as json
+
+class KVMsg(object):
+"""[-17-]
+[-18-]Message is formatted on wire as 5 frames:
+"""
+    key = None
+    sequence = 0
+    uuid=None
+    properties = None
+    body = None
+
+    def __init__(self, sequence, uuid=None, key=None, properties=None, body=None):
+        assert isinstance(sequence, int)
+        self.sequence = sequence
+        if uuid is None:
+            uuid = uuid4().bytes
+        self.uuid = uuid
+        self.key = key
+        self.properties = {} if properties is None else properties
+        self.body = body
+
+    def __getitem__(self, k):
+        return self.properties[k]
+
+    def __setitem__(self, k, v):
+        self.properties[k] = v
+
+    def get(self, k, default=None):
+        return self.properties.get(k, default)
+
+    def store(self, dikt):
+        """[-46-]   Store me in a dict if I have anything to store
+[-47-]       else delete me from the dict.[-end-]"""
+        if self.key is not None and self.body is not None:
+            dikt[self.key] = self
+        elif self.key in dikt:
+            del dikt[self.key]
+
+    def send(self, socket):
+
+        key = '' if self.key is None else self.key
+        seq_s = struct.pack('!q', self.sequence)
+        body = '' if self.body is None else self.body
+        prop_s = json.dumps(self.properties)
+        socket.send_multipart([ key, seq_s, self.uuid, prop_s, body ])
+
+    @classmethod
+    def recv(cls, socket):
+
+        return cls.from_msg(socket.recv_multipart())
+
+    @classmethod
+    def from_msg(cls, msg):
+
+        key, seq_s, uuid, prop_s, body = msg
+        key = key if key else None
+        seq = struct.unpack('!q',seq_s)[0]
+        body = body if body else None
+        prop = json.loads(prop_s)
+        return cls(seq, uuid=uuid, key=key, properties=prop, body=body)
+
+    def dump(self):
+        if self.body is None:
+            size = 0
+            data='NULL'
+        else:
+            size = len(self.body)
+            data=repr(self.body)
+        print >> sys.stderr, "[seq:{seq}][key:{key}][size:{size}] {props} {data}".format(
+            seq=self.sequence,
+            key=self.key,
+            size=size,
+            props=json.dumps(self.properties),
+            data=data,
+        )
+
+#[-91-] Runs self test of class
+
+def test_kvmsg (verbose):
+    print " * kvmsg: ",
+
+    ctx = zmq.Context()
+    output = ctx.socket(zmq.DEALER)
+    output.bind("ipc://kvmsg_selftest.ipc")
+    input = ctx.socket(zmq.DEALER)
+    input.connect("ipc://kvmsg_selftest.ipc")
+
+    kvmap = {}
+    kvmsg = KVMsg(1)
+    kvmsg.key = "key"
+    kvmsg.body = "body"
+    if verbose:
+        kvmsg.dump()
+    kvmsg.send(output)
+    kvmsg.store(kvmap)
+
+    kvmsg2 = KVMsg.recv(input)
+    if verbose:
+        kvmsg2.dump()
+    assert kvmsg2.key == "key"
+    kvmsg2.store(kvmap)
+
+    assert len(kvmap) == 1
+
+    kvmsg = KVMsg(2, key="key", body="body")
+    kvmsg["prop1"] = "value1"
+    kvmsg["prop2"] = "value2"
+    kvmsg["prop3"] = "value3"
+    assert kvmsg["prop1"] == "value1"
+    if verbose:
+        kvmsg.dump()
+    kvmsg.send(output)
+    kvmsg2 = KVMsg.recv(input)
+    if verbose:
+        kvmsg2.dump()
+    #[-130-] ensure properties were preserved
+    assert kvmsg2.key == kvmsg.key
+    assert kvmsg2.body == kvmsg.body
+    assert kvmsg2.properties == kvmsg.properties
+    assert kvmsg2["prop2"] == kvmsg["prop2"]
+
+    print "OK"
+
+if __name__ == '__main__':
+    test_kvmsg('-v' in sys.argv)

data/spec/assets/source_code/ruby.rb

@@ -0,0 +1,36 @@
+
+
+#[-3-]encoding: utf-8
+#[-4-]Source code from [https://github.com/thoughtbot/paperclip]
+#[-5-]Copyright (c) 2008-2014 Jon Yurek and thoughtbot, inc.
+require 'uri'
+require 'paperclip/url_generator'
+require 'active_support/deprecation'
+
+module Paperclip
+  #[-11-]The Attachment class manages the files for a given attachment. It saves
+  #[-12-]when the model saves, deletes when the model is destroyed, and processes
+  #[-13-]the file upon assignment.
+  class Attachment
+    #[-15-]What gets called when you call instance.attachment = File. It clears
+    #[-16-]errors, assigns attributes, and processes the file. It
+    #[-17-]also queues up the previous file for deletion, to be flushed away on
+    #[-18-]#save of its host.  In addition to form uploads, you can also assign
+=begin
+[-20-]another Paperclip attachment:
+[-21-]  new_user.avatar = old_user.avatar
+[-22-]  new_user.avatar = old_user.avatar
+=end
+    def assign uploaded_file
+      @dirty = true
+
+      post_process(*only_process) if post_processing
+
+      #[-29-]Reset the file size if the original file was reprocessed.
+      instance_write(:file_size,   @queued_for_write[:original].size)
+      instance_write(:fingerprint, @queued_for_write[:original].fingerprint) if instance_respond_to?(:fingerprint)
+      updater = :"#{name}_file_name_will_change!"
+      instance.send updater if instance.respond_to? updater
+    end
+  end
+end

data/spec/assets/source_code/sass.sass

@@ -0,0 +1,77 @@
+@import 'sidebar'
+@import 'index_contents'
+@import 'page_contents'
+@import 'post_contents'
+
+//[-6-] single line
+/*[-7-] multi line[-end-]*/
+//[-8-]-------------------- /* */
+/*[-9-] multi_line
+[-10-] multi_line
+[-11-] multi_line[-end-]*/
+=blockquote
+  +transition(all, 0.3s)
+  color: #606060
+  background: #f9f9f9
+  position: relative
+  overflow: hidden
+  display: block
+  padding: 15px 60px
+  margin-top: $space_width
+  margin-bottom: $space_width
+  p
+    margin: 0px
+  &:hover
+    color: #454545
+    &:before
+      color: #b8cec7
+  &:before
+    left: -3px
+  &:after
+    right: -2px
+  &:before, &:after
+    display: block
+    content: "^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"
+    font-size: 24px
+    overflow: hidden
+    position: absolute
+    top: 0px
+    bottom: 0px
+    line-height: 0.4em
+    word-break: break-all
+    color: #d0dfda
+    width: 7px !important
+
+#main_contents
+  #breadcrumb
+    display: block
+    margin-top: $space_width / 2
+    margin-bottom: $space_width / 2
+    a
+      text-decoration: none
+      color: $cl_normal
+  .post_row
+    +box-shadow(0px 4px 4px #eee)
+    +readable_font
+    background-color: white
+    border: 1px solid #eee
+    color: #403f3f
+    font-size: 14px
+    line-height: 20px
+    text-shadow: 0 1px 0 rgba(255,255,255,1)
+    position: relative
+    padding-top: $space_width
+    padding-bottom: $space_width
+    margin-bottom: $space_width
+
+    header.field-items, footer
+      h1
+        padding-left: $space_width
+        padding-right: $space_width
+        &, & > a
+          font-size: 30px
+          letter-spacing: -1px
+          line-height: 1.3
+          +readable_font
+          +link-colors($cl_normal, $cl_normal, $cl_normal, $cl_normal)
+          text-decoration: none

data/spec/assets/source_code/scala.scala

@@ -0,0 +1,46 @@
+/*[-1-]Attribution-Share Alike 3.0 License, copyright (c) 2010 Pieter Hintjens, modified @alpaca-tc
+[-2-]Asynchronous client-to-server (DEALER to BROKER)
+[-3-]
+[-4-]While this example runs in a single process, that is just to make
+[-5-]it easier to start and stop the example. Each task has its own
+[-6-]context and conceptually acts as a separate process.
+[-7-]
+[-8-]@Author:     Giovanni Ruggiero
+[-9-]@Email:      giovanni.ruggiero@gmail.com
+*/
+
+import org.zeromq.ZMQ
+import ZHelpers._
+
+object asyncsrv  {
+ //[-16-]  ---------------------------------------------------------------------
+ //[-17-]  This is our client task
+ //[-18-]  It connects to the server, and then sends a request once per second
+ //[-19-]  It collects responses as they arrive, and it prints them out. We will
+ //[-20-]  run several client tasks in parallel, each with a different random ID.
+ class ClientTask() extends Runnable {
+   def run() {
+     val ctx = ZMQ.context(1)
+     val client = ctx.socket(ZMQ.DEALER)
+     setID(client);
+     val identity = new String(client getIdentity)
+     client.connect("tcp://localhost:5570")
+     val poller = ctx.poller(1)
+
+     poller.register(client,ZMQ.Poller.POLLIN)
+     var requestNbr = 0
+     while (true) { //[-32-]  Tick once per second, pulling in arriving messages
+       for (centitick <- 1 to 100) {
+         poller.poll(10000)
+         if(poller.pollin(0)) {
+           val msg = new ZMsg(client)
+           printf("%s : %s\n", identity, msg.bodyToString)
+         }
+       }
+       requestNbr += 1
+       val msg = new ZMsg("request: %d" format requestNbr)
+       client.sendMsg(msg)
+     }
+   }
+ }
+}

data/spec/assets/source_code/scss.scss

@@ -0,0 +1,93 @@
+@import "sidebar"
+@import "index_contents"
+@import "page_contents"
+@import "post_contents"
+
+//[-6-] single line
+/*[-7-] multi line[-end-]*/
+//[-8-]-------------------- /*
+/*[-9-] multi_line [-end-]*/
+//[-10-] multi_line {}
+
+//[-12-] multi_line*/ {}[-end-]
+
+@mixin blockquote {
+  @include transition(all, 0.3s)
+  color: #606060
+  background: #f9f9f9
+  position: relative
+  overflow: hidden
+  display: block
+  padding: 15px 60px
+  margin-top: $space_width
+  margin-bottom: $space_width
+  p {
+    margin: 0px
+  }
+  &:hover {
+    color: #454545
+    &:before {
+      color: #b8cec7
+    }
+  }
+  &:before {
+    left: -3px
+  }
+  &:after {
+    right: -2px
+  }
+  &:before, &:after {
+    display: block
+    content: "^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"
+    font-size: 24px
+    overflow: hidden
+    position: absolute
+    top: 0px
+    bottom: 0px
+    line-height: 0.4em
+    word-break: break-all
+    color: #d0dfda
+    width: 7px !important
+  }
+}
+
+#main_contents {
+  #breadcrumb {
+    display: block
+    margin-top: $space_width / 2
+    margin-bottom: $space_width / 2
+    a {
+      text-decoration: none
+      color: $cl_normal
+    }
+  }
+  .post_row {
+    @include box-shadow(0px 4px 4px #eeeeee)
+    @include readable_font
+    background-color: white
+    border: 1px solid #eeeeee
+    color: #403f3f
+    font-size: 14px
+    line-height: 20px
+    text-shadow: 0 1px 0 rgba(255, 255, 255, 1)
+    position: relative
+    padding-top: $space_width
+    padding-bottom: $space_width
+    margin-bottom: $space_width
+    header.field-items, footer {
+      h1 {
+        padding-left: $space_width
+        padding-right: $space_width
+        &, & > a {
+          font-size: 30px
+          letter-spacing: -1px
+          line-height: 1.3
+          @include readable_font
+          @include link-colors($cl_normal, $cl_normal, $cl_normal, $cl_normal)
+          text-decoration: none
+        }
+      }
+    }
+    /*[-91-] multi_line [-end-]*/
+  }
+}

data/spec/assets/source_code/shell.sh

@@ -0,0 +1,5 @@
+#[-1-] print the name and contents of the current
+#[-2-] working directory
+echo "This is from a shell script"
+pwd     #[-4-] print the directory name
+ls      #[-5-] print the directory contents

data/spec/assets/source_code/sql.sql

@@ -0,0 +1,11 @@
+/*[-1-] this is comment
+[-2-]comemnt out[-end-]*/
+select SessionSID
+, TargetID
+--[-5-], TargetName
+, FEDSurveyName
+, SupplierID
+, ClientLK_ResponseStatusID
+from BI_Sessions (nolock)
+WHERE EntryDate BETWEEN '05-15-2012' AND '05-16-2012'
+AND SupplierID = 336

data/spec/assets/source_code/tex.tex

@@ -0,0 +1,20 @@
+\documentclass[12pt]{article}
+%[-2-]  options include 12pt or 11pt or 10pt
+%[-3-]  classes include article, report, book, letter, thesis
+
+\title{This is the title}
+\author{Author One \\ Author Two}
+\date{29 February 2004}
+
+\begin{document}
+\maketitle
+
+This is the content of this document.%[-12-]
+
+This is the 2nd paragraph.
+\%Here is an inline formula:
+$   V = \frac{4 \pi r^3}{3}  $.
+And appearing immediately below
+is a displayed formula:
+$$  V = \frac{4 \pi r^3}{3}  $$
+\end{document}

data/spec/assets/source_code/text.txt

@@ -0,0 +1,15 @@
+#[-1-] strip\_comment
+
+#[-3-] Description
+
+comment\_extractor extracts the comment out from a source code.
+
+#[-7-] Installation
+
+CommentExtractor has been tested with ruby 2.1.
+
+```sh
+git clone https://github.com/alpaca-tc/comment_extractor
+cd comment_extractor
+rake install
+```

data/spec/assets/source_code/vim

@@ -0,0 +1,17 @@
+"[-1-] ----------------------------------------
+"[-2-] basic settings "{{{
+set nocompatible
+let &directory = g:my.dir.swap_dir
+set viminfo='1000,<800,s300,\"1000,f1,:1000,/1000
+execute 'set viminfo+=n' . g:my.dir.viminfo . '/.viminfo'
+
+
+
+set visualbell t_vb=
+set helplang=en
+set langmenu=en_us.UTF-8
+language en_US.UTF-8
+"[-14-]
+\[-15-]
+"[-16-] ----------------------------------------
+

data/spec/assets/source_code/yaml.yml

@@ -0,0 +1,44 @@
+defaults: &defaults
+  URL: ""
+  HTTPS_URL: ""
+
+  ADMIN_ENABLED: true
+
+  ANALYTICS_ENABLED: false
+
+  AWS_ACCESS_KEY_ID:
+  AWS_SECRET_ACCESS_KEY:
+  AWS_S3_BUCKETS:
+  AWS_S3_OBJECT_CACHE_CONTROL_MAX_AGE: 7776000
+
+  YAHOOJ_WALLET_API_HOST:
+  YAHOOJ_APPID:
+  YAHOOJ_PRIVATE_KEY:
+  YAHOOJ_WGW_KEY:
+  YAHOOJ_PID_PREMIUM_PROFILE_MONTHLY:
+  YAHOOJ_PROPERTY_ID:
+
+  #[-21-] https://dev.twitter.com/apps
+  TWITTER_CONSUMER_KEY: XXXXXXXXXXXXXXXXXXXXXX
+  TWITTER_CONSUMER_SECRET: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+
+  #[-25-] https://developers.facebook.com/apps
+  FACEBOOK_APP_KEY: XXXXXXXXXXXXXXX
+  FACEBOOK_APP_SECRET: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+
+  #[-29-] https://code.google.com/apis/console/
+  GOOGLE_CLIENT_ID: XXXXXXXXXXXXX.XXXX.googleusercontent.com
+  GOOGLE_CLIENT_SECRET: XXXXXXXXXXXXXXXXXXXXXXXX
+
+  #[-33-] https://code.google.com/apis/console/
+  GPLUS_CLIENT_ID: XXXXXXXXXXXXX.XXXX.googleusercontent.com
+  GPLUS_CLIENT_SECRET: #[-35-]XXXXXXXXXXXXXXXXXXXXXXXX
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/spec/assets/stripper/children/children.rb

@@ -0,0 +1 @@
+# Hello World

data/spec/assets/stripper/test.rb

@@ -0,0 +1 @@
+# Hello World

data/spec/comment_extractor/code_object/comment_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'comment_extractor/code_object/comment'
+
+module CommentExtractor
+  describe CodeObject::Comment do
+    describe '.new' do
+      subject { described_class.new(line: line) }
+      let(:line) { 21 }
+
+      it "returns a instance of #{described_class}" do
+        expect(subject.line).to eql(line)
+      end
+    end
+  end
+end

data/spec/comment_extractor/code_object_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'comment_extractor/code_object'
+
+module CommentExtractor
+  describe CodeObject do
+    describe 'ClassMethods' do
+      describe '.new' do
+        subject { described_class.new(value: value, other: :other) }
+        let(:value) { 'value' }
+
+        it "returns a instance of #{described_class}" do
+          expect(subject.value).to eql value
+          expect(subject.metadata).to eql({ other: :other })
+        end
+      end
+    end
+  end
+end