htsn-import.cabal

   1 name:           htsn-import
   2 version:        0.0.1
   3 cabal-version:  >= 1.8
   4 author:         Michael Orlitzky
   5 maintainer:     Michael Orlitzky <michael@orlitzky.com>
   6 category:       Utils
   7 license:        GPL-3
   8 license-file:   doc/LICENSE
   9 build-type:     Simple
  10 extra-source-files:
  11   doc/dbschema/*.png
  12   doc/htsn-importrc.example
  13   doc/man1/htsn-import.1
  14   makefile
  15   test/xml/*.xml
  16   schema/*.dtd
  17   schemagen/Heartbeat/*.xml
  18   schemagen/injuriesxml/*.xml
  19   schemagen/Injuries_Detail_XML/*.xml
  20   schemagen/newsxml/*.xml
  21   schemagen/Odds_XML/*.xml
  22   schemagen/weatherxml/*.xml
  23 synopsis:
  24   Import XML files from The Sports Network into an RDBMS.
  25 description:
  26   /Usage/:
  27   .
  28   @
  29   htsn-import [OPTIONS] [FILES]
  30   @
  31   .
  32   The Sports Network <http://www.sportsnetwork.com/> offers an XML feed
  33   containing various sports news and statistics. Our sister program
  34   /htsn/ is capable of retrieving the feed and saving the individual
  35   XML documents contained therein. But what to do with them?
  36   .
  37   The purpose of /htsn-import/ is to take these XML documents and
  38   get them into something we can use, a relational database management
  39   system (RDBMS), loosely known as a SQL database. The structure of
  40   relational database, is, well, relational, and the feed XML is not. So
  41   there is some work to do before the data can be inserted.
  42   .
  43   First, we must parse the XML. Each supported document type (see below)
  44   has a full pickle/unpickle implementation (\"pickle\" is simply a
  45   synonym for serialize here). That means that we parse the entire
  46   document into a data structure, and if we pickle (serialize) that data
  47   structure, we get the exact same XML document tha we started with.
  48   .
  49   This is important for two reasons. First, it serves as a second level
  50   of validation. The first validation is performed by the XML parser,
  51   but if that succeeds and unpicking fails, we know that something is
  52   fishy. Second, we don't ever want to be surprised by some new element
  53   or attribute showing up in the XML. The fact that we can unpickle the
  54   whole thing now means that we won't be surprised in the future.
  55   .
  56   The aforementioned feature is especially important because we
  57   automatically migrate the database schema every time we import a
  58   document. If you attempt to import a \"newsxml.dtd\" document, all
  59   database objects relating to the news will be created if they do not
  60   exist. We don't want the schema to change out from under us without
  61   warning, so it's important that no XML be parsed that would result in
  62   a different schema than we had previously. Since we can
  63   pickle/unpickle everything already, this should be impossible.
  64   .
  65   Examples and usage documentation are available in the man page.
  66
  67 executable htsn-import
  68   build-depends:
  69     base                        == 4.*,
  70     cmdargs                     >= 0.10.6,
  71     configurator                == 0.2.*,
  72     directory                   == 1.2.*,
  73     filepath                    == 1.3.*,
  74     hslogger                    == 1.2.*,
  75     htsn-common                 == 0.0.1,
  76     hxt                         == 9.3.*,
  77     groundhog                   == 0.4.*,
  78     groundhog-postgresql        == 0.4.*,
  79     groundhog-sqlite            == 0.4.*,
  80     groundhog-th                == 0.4.*,
  81     MissingH                    == 1.2.*,
  82     old-locale                  == 1.0.*,
  83     tasty                       == 0.7.*,
  84     tasty-hunit                 == 0.4.*,
  85     time                        == 1.4.*,
  86     transformers                == 0.3.*,
  87     tuple                       == 0.2.*
  88
  89   main-is:
  90     Main.hs
  91
  92   hs-source-dirs:
  93     src/
  94
  95   other-modules:
  96     Backend
  97     CommandLine
  98     Configuration
  99     ConnectionString
 100     ExitCodes
 101     OptionalConfiguration
 102     TSN.Codegen
 103     TSN.DbImport
 104     TSN.Picklers
 105     TSN.XmlImport
 106     TSN.XML.Heartbeat
 107     TSN.XML.Injuries
 108     TSN.XML.InjuriesDetail
 109     TSN.XML.News
 110     TSN.XML.Odds
 111     Xml
 112
 113   ghc-options:
 114     -Wall
 115     -fwarn-hi-shadowing
 116     -fwarn-missing-signatures
 117     -fwarn-name-shadowing
 118     -fwarn-orphans
 119     -fwarn-type-defaults
 120     -fwarn-tabs
 121     -fwarn-incomplete-record-updates
 122     -fwarn-monomorphism-restriction
 123     -fwarn-unused-do-bind
 124     -rtsopts
 125     -threaded
 126     -optc-O3
 127     -optc-march=native
 128     -O2
 129
 130   ghc-prof-options:
 131     -prof
 132     -fprof-auto
 133     -fprof-cafs
 134     -- The following unbreak profiling with template haskell. We have
 135     -- to build the program twice; once without profile and again with
 136     -- these flags.
 137     -hisuf hi_p
 138     -osuf o_p
 139
 140
 141 test-suite testsuite
 142   type: exitcode-stdio-1.0
 143   hs-source-dirs: src test
 144   main-is: TestSuite.hs
 145   build-depends:
 146     base                        == 4.*,
 147     cmdargs                     >= 0.10.6,
 148     configurator                == 0.2.*,
 149     directory                   == 1.2.*,
 150     filepath                    == 1.3.*,
 151     hslogger                    == 1.2.*,
 152     htsn-common                 == 0.0.1,
 153     hxt                         == 9.3.*,
 154     groundhog                   == 0.4.*,
 155     groundhog-postgresql        == 0.4.*,
 156     groundhog-sqlite            == 0.4.*,
 157     groundhog-th                == 0.4.*,
 158     MissingH                    == 1.2.*,
 159     old-locale                  == 1.0.*,
 160     tasty                       == 0.7.*,
 161     tasty-hunit                 == 0.4.*,
 162     time                        == 1.4.*,
 163     transformers                == 0.3.*,
 164     tuple                       == 0.2.*
 165
 166   -- It's not entirely clear to me why I have to reproduce all of this.
 167   ghc-options:
 168     -Wall
 169     -fwarn-hi-shadowing
 170     -fwarn-missing-signatures
 171     -fwarn-name-shadowing
 172     -fwarn-orphans
 173     -fwarn-type-defaults
 174     -fwarn-tabs
 175     -fwarn-incomplete-record-updates
 176     -fwarn-monomorphism-restriction
 177     -fwarn-unused-do-bind
 178     -rtsopts
 179     -threaded
 180     -optc-O3
 181     -optc-march=native
 182     -O2
 183
 184
 185 test-suite doctests
 186   type: exitcode-stdio-1.0
 187   hs-source-dirs: test
 188   main-is: Doctests.hs
 189   build-depends:
 190     base      == 4.*,
 191     -- Additional test dependencies.
 192     doctest   == 0.9.*
 193
 194   -- It's not entirely clear to me why I have to reproduce all of this.
 195   ghc-options:
 196     -Wall
 197     -fwarn-hi-shadowing
 198     -fwarn-missing-signatures
 199     -fwarn-name-shadowing
 200     -fwarn-orphans
 201     -fwarn-type-defaults
 202     -fwarn-tabs
 203     -fwarn-incomplete-record-updates
 204     -fwarn-monomorphism-restriction
 205     -fwarn-unused-do-bind
 206     -rtsopts
 207     -threaded
 208     -optc-O3
 209     -optc-march=native
 210     -O2
 211
 212
 213 source-repository head
 214   type: git
 215   location: http://michael.orlitzky.com/git/htsn-import.git
 216   branch: master