PageRenderTime 147ms CodeModel.GetById 30ms RepoModel.GetById 1ms app.codeStats 0ms

/lib/App/PipeFilter.pm

https://github.com/ingydotnet/app-pipefilter
Perl | 91 lines | 64 code | 26 blank | 1 comment | 0 complexity | cc9f5425b5bfd0beed99f30b6cade392 MD5 | raw file
    

  1. =head1 NAME
    2. 

  2. 

  3. App::PipeFilter
    4. 

  4. 

  5. =head1 DESCRIPTION
    6. 

  6. 

  7. App::PipeFilter is a distribution of shell pipeline filters designed
    8. 

  8. to work with structured data like JSON rather than whitespace
    9. 

  9. separated fields.
    10. 

  10. 

  11. For example, jcut is a simple version of cut(1) that understands JSON
    12. 

  12. objects rather than whitespace separated fields.
    13. 

  13. 

  14.   % head -1 sample.json
    15. 

  15.   {"network":"freenode","channel":"#perl","nick":"dngor","karma":"120"}
    16. 

  16. 

  17.   % jcut -o network -o channel < eg/sample.json | sort | uniq
    18. 

  18.   {"network":"efnet","channel":"#perl"}
    19. 

  19.   {"network":"efnet","channel":"#poe"}
    20. 

  20.   {"network":"efnet","channel":"#reflex"}
    21. 

  21.   {"network":"freenode","channel":"#perl"}
    22. 

  22.   {"network":"freenode","channel":"#poe"}
    23. 

  23.   {"network":"freenode","channel":"#reflex"}
    24. 

  24.   {"network":"magnet","channel":"#perl"}
    25. 

  25.   {"network":"magnet","channel":"#poe"}
    26. 

  26.   {"network":"magnet","channel":"#reflex"}
    27. 

  27. 

  28. The jsonpath filter supports more complex expressions using
    29. 

  29. JSON::Path's variant of JSONPath.
    30. 

    31. 

  31.   curl -s 'http://api.duckduckgo.com/?q=poe&o=json' |
    32. 

  32.   jsonpath -o '$..Topics.*.FirstURL' -o '$..Topics.*.Text' |
    33. 

  33.   grep -i perl |
    34. 

  34.   jmap -i col0 -o url -i col1 -o title |
    35. 

  35.   json2yaml
    36. 

  36.   --- 
    37. 

  37.   title: Perl Object Environment, a library for event driven multitasking for the Perl programming language
    38. 

  38.   url: http://duckduckgo.com/Perl_Object_Environment
    39. 

  39. 

  40. =head1 DESIGN GOAL
    41. 

  41. 

  42. App::PipeFilter utilities generally follow the UNIX convention of
    43. 

  43. printing one record per line of text.  This maximizes compatibility
    44. 

  44. with UNIX utilities like sort(1), uniq(1) and grep(1).
    45. 

  45. 

  46. =head1 PRO TIPS
    47. 

  47. 

  48. JSON isn't particularly concise, so put grep(1), jcut(1) and other
    49. 

  49. filters that eliminate data as early as possible in pipelines.
    50. 

  50. 

  51. =head1 SEE ALSO
    52. 

  52. 

  53. L<jcat> - concatenate and print JSON files
    54. 

  54. 

  55. L<jcut> - cut out selected portions of each JSON object in a file
    56. 

  56. 

  57. L<jmap> - map input JSON fields to output JSON fields by renaming them
    58. 

  58. 

  59. L<json2yaml> - convert files of JSON objects into a stream of YAML objects
    60. 

  60. 

  61. L<jsonpath> - use JSON::Path to cut out selected portions of JSON objects
    62. 

  62. 

  63. L<jsort> - sort input files of JSON objects on key fields
    64. 

  64. 

  65. L<mysql2json> - convert mysql -B output to JSON object streams
    66. 

  66. 

  67. L<http://json.org/>
    68. 

  68. 

  69. L<http://search.cpan.org/perldoc?JSON::Path>
    70. 

  70. 

  71. L<http://goessner.net/articles/JsonPath/>
    72. 

  72. 

  73. =head1 BUGS
    74. 

  74. 

  75. L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-PipeFilter>
    76. 

  76. 

  77. =head1 REPOSITORY
    78. 

  78. 

  79. L<https://github.com/rcaputo/app-pipefilter>
    80. 

  80. 

  81. =head1 COPYRIGHT and LICENSE
    82. 

  82. 

  83. App::PipeFilter
    84. 

  84. is Copyright 2011 by Rocco Caputo.
    85. 

  85. All rights are reserved.
    86. 

  86. App::PipeFilter
    87. 

  87. is released under the same terms as Perl itself.
    88. 

  88. 

  89. =cut
    90. 

  90. 

  91. # vim: ts=2 sw=2 expandtab
    92. 

  92.